调用CreateCloudMigrationTask接口创建RDS PostgreSQL迁移上云任务。

前提条件

只有上云前检查结果为成功时，才能创建迁移上云任务。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateCloudMigrationTask

系统规定参数。取值：CreateCloudMigrationTask。

DBInstanceName String 是 pgm-bp102g323jd4****

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

SourceIpAddress String 是 172.16.XX.XX

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

  • ECS自建PostgreSQL数据库一键上云场景，配置ECS实例的私网IP。获取方法请参见查看IP地址。
  • IDC自建PostgreSQL数据库一键上云场景，配置为IDC的内网IP。
  • 公网PostgreSQL数据库一键上云场景，配置为PostgreSQL的公网IP。
SourcePort Long 是 5432

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

SourceAccount String 是 migratetest

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

SourcePassword String 是 123456

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

TaskName String 否 362c6c7a-4d20-4eac-898c-1495ceab374c

任务名称。自定义，未设置时系统自动生成。
SourceCategory String 是 ecsOnVpc

自建PostgreSQL的类型。

  • idcOnVpc：线下IDC自建PostgreSQL（IDC与VPC打通）
  • ecsOnVpc：阿里云ECS自建PostgreSQL
  • internet：公网PostgreSQL

返回数据

名称 类型 示例值 描述
DBInstanceName String pgm-bp102g323jd4****

目标实例名称。
RequestId String 8B993DA9-5272-5414-94E3-4CA8BA0146C2

请求ID。
TaskId Long 440437220

任务ID。
TaskName String 362c6c7a-4d20-4eac-898c-1495ceab374c

任务名称。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=CreateCloudMigrationTask
&DBInstanceName=pgm-bp102g323jd4****
&SourceIpAddress=172.16.XX.XX
&SourcePort=5432
&SourceAccount=migratetest
&SourcePassword=123456
&TaskName=362c6c7a-4d20-4eac-898c-1495ceab374c
&SourceCategory=ecsOnVpc
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateCloudMigrationTaskResponse>
    <DBInstanceName>pgm-bp102g323jd4****</DBInstanceName>
    <RequestId>8B993DA9-5272-5414-94E3-4CA8BA0146C2</RequestId>
    <TaskId>440437220</TaskId>
    <TaskName>362c6c7a-4d20-4eac-898c-1495ceab374c</TaskName>
</CreateCloudMigrationTaskResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 IncorrectDBInstanceState The current instance state does not support this operation. 当前实例状态不支持此操作。
403 IncorrectDBInstance The current DB instance does not support this operation. 操作失败，当前实例不支持此操作。
403 IncorrectDBInstanceType The database instance type does not support the operation. 操作失败，当前数据库类型不支持该操作。
404 InvalidDBInstanceName.NotFound The database instance does not exist. 数据库实例名称不存在。请确认数据名称是否正确。
404 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. 操作失败，实例处于锁定状态。

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