Creates a cloud migration task for an ApsaraDB RDS for PostgreSQL instance.
Operation description
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceName | string | Yes | The ID of the destination instance. You can call the DescribeDBInstances operation to query the instance ID. | pgm-bp102g323jd4**** |
SourceIpAddress | string | Yes | The private or public IP address that is used to connect to the self-managed PostgreSQL instance.
| 172.16.XX.XX |
SourcePort | long | Yes | The port number that is used to connect to the self-managed PostgreSQL instance. You can run the | 5432 |
SourceAccount | string | Yes | The username of the account that is used to connect to the self-managed PostgreSQL instance. Enter the username of the account that you created in the Create an account for cloud migration on a self-managed PostgreSQL instance topic. | migratetest |
SourcePassword | string | Yes | The password of the account that is used to connect to the self-managed PostgreSQL instance. Enter the password of the account that you created in the Create an account for cloud migration on a self-managed PostgreSQL instance topic. | 123456 |
TaskName | string | No | The name of the task. If you do not specify this parameter, ApsaraDB RDS automatically generates a name for the cloud migration task. | 362c6c7a-4d20-4eac-898c-1495ceab374c |
SourceCategory | string | Yes | The environment in which the self-managed PostgreSQL instance runs.
| ecsOnVpc |
Response parameters
Examples
Sample success responses
JSON
format
{
"DBInstanceName": "pgm-bp102g323jd4****",
"RequestId": "8B993DA9-5272-5414-94E3-4CA8BA0146C2",
"TaskId": 440437220,
"TaskName": "362c6c7a-4d20-4eac-898c-1495ceab374c"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | IncorrectDBInstanceState | The current instance state does not support this operation. | The operation is not supported. The RDS instance is not in a ready state. |
403 | IncorrectDBInstance | The current DB instance does not support this operation. | The operation failed. The operation is not supported for the RDS instance. |
403 | IncorrectDBInstanceType | The database instance type does not support the operation. | The operation failed. The operation is not supported for the database engine of the RDS instance. |
404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | The name of the RDS instance cannot be found. Check the name of the RDS instance. |
404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | The operation failed. The RDS instance is locked. |
For a list of error codes, visit the Service error codes.