CreateCloudMigrationTask - ApsaraDB RDS - Alibaba Cloud Documentation Center

Creates a cloud migration task for an ApsaraDB RDS for PostgreSQL instance.

Operation description

Supported database engines

PostgreSQL

References

Note : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Use the cloud migration feature

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:CreateCloudMigrationTask	create	*DBInstance `acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}`	rds:ResourceTag	none

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. If the self-managed PostgreSQL instance resides on an Elastic Compute Service (ECS) instance, enter the private IP address of the ECS instance. For more information about how to obtain the private IP address of an ECS instance, see View IP addresses. If the self-managed PostgreSQL instance resides in a data center, enter the private IP address of the data center.	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 `netstat -a \| grep PGSQL` command to obtain the port number.	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. idcOnVpc: The self-managed PostgreSQL instance resides in a data center. The data center can communicate with the VPC to which the ApsaraDB RDS for PostgreSQL instance belongs. ecsOnVpc: The self-managed PostgreSQL instance resides on an ECS instance.	ecsOnVpc

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
DBInstanceName	string	The name of the instance.	pgm-bp102g323jd4****
RequestId	string	The ID of the request.	8B993DA9-5272-5414-94E3-4CA8BA0146C2
TaskId	long	The ID of the task.	440437220
TaskName	string	The name of the task.	362c6c7a-4d20-4eac-898c-1495ceab374c

Examples

Sample success responses

JSONformat

{
  "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.