文档

CreateCloudMigrationTask - 创建RDS PostgreSQL迁移上云任务

更新时间:

该接口用于创建RDS PostgreSQL迁移上云任务。

接口说明

适用引擎

  • RDS PostgreSQL

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

一键上云

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:CreateCloudMigrationTaskWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceNamestring

目标实例 ID。可调用 DescribeDBInstances 接口查询。

pgm-bp102g323jd4****
SourceIpAddressstring

自建 PostgreSQL 数据库的内网 IP 或公网 IP。

  • ECS 自建 PostgreSQL 数据库一键上云场景,配置 ECS 实例的私网 IP。获取方法请参见查看 IP 地址
  • IDC 自建 PostgreSQL 数据库一键上云场景,配置为 IDC 的内网 IP。
172.16.XX.XX
SourcePortlong

自建 PostgreSQL 数据库的端口。可通过netstat -a | grep PGSQL命令查看。

5432
SourceAccountstring

用户名。创建迁移账号步骤创建的数据库账号。

migratetest
SourcePasswordstring

密码。创建迁移账号步骤创建的数据库账号的密码。

123456
TaskNamestring

任务名称。自定义,未设置时系统自动生成。

362c6c7a-4d20-4eac-898c-1495ceab374c
SourceCategorystring

自建 PostgreSQL 的类型。

  • idcOnVpc:线下 IDC 自建 PostgreSQL(IDC 与 VPC 打通)
  • ecsOnVpc:阿里云 ECS 自建 PostgreSQL
ecsOnVpc

返回参数

名称类型描述示例值
object

返回参数详情。

DBInstanceNamestring

目标实例名称。

pgm-bp102g323jd4****
RequestIdstring

请求 ID。

8B993DA9-5272-5414-94E3-4CA8BA0146C2
TaskIdlong

任务 ID。

440437220
TaskNamestring

任务名称。

362c6c7a-4d20-4eac-898c-1495ceab374c

示例

正常返回示例

JSON格式

{
  "DBInstanceName": "pgm-bp102g323jd4****",
  "RequestId": "8B993DA9-5272-5414-94E3-4CA8BA0146C2",
  "TaskId": 440437220,
  "TaskName": "362c6c7a-4d20-4eac-898c-1495ceab374c"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectDBInstanceStateThe current instance state does not support this operation.当前实例状态不支持此操作。
403IncorrectDBInstanceThe current DB instance does not support this operation.操作失败,当前实例不支持此操作。
403IncorrectDBInstanceTypeThe database instance type does not support the operation.操作失败,当前数据库类型不支持该操作。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。
404IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈