All Products
Search

This Product

    ApsaraDB RDS:CreateCloudMigrationPrecheckTask

    Document Center

    ApsaraDB RDS:CreateCloudMigrationPrecheckTask

    Last Updated:Aug 28, 2026

    Creates an assessment task for cloud migration to 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.

    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:
      • For mandatory resource types, indicate with a prefix of * .
      • 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:CreateCloudMigrationPrecheckTask create
    *DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		 none

    Request parameters

    Parameter Type Required Description Example
    DBInstanceName string Yes

    The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

    		 pgm-bp102g323jd4****
    SourceIpAddress string Yes

    The private IP address that is used to connect to the self-managed PostgreSQL instance.

    • If the self-managed PostgreSQL instance resides on an 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 an on-premises data center, enter the private IP address of the on-premises data center.
    		 172.2.XX.XX
    SourcePort long Yes

    The port that is used to connect to the self-managed PostgreSQL instance. You can run the netstat -a | grep PGSQL command to view the port.

    		 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.

    		 slf7w7wj3g
    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.

    		 60F9A12A-16B8-4728-B099-4CA38D32C31C
    TaskId long

    The ID of the task.

    		 439946016
    TaskName string

    The name of the task.

    		 slf7w7wj3g

    Examples

    Sample success responses

    JSONformat

    {
  "DBInstanceName": "pgm-bp102g323jd4****",
  "RequestId": "60F9A12A-16B8-4728-B099-4CA38D32C31C",
  "TaskId": 439946016,
  "TaskName": "slf7w7wj3g"
}

    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.
    400 InvalidSourceCategory specified source category is invalid. The specified source category is invalid.
    400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. A package instance is not allowed to operate independently.
    400 Price.PricingPlanResultNotFound Pricing plan price result not found. Pricing plan price result not found.
    400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
    400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. Your account available limit is less than 0, please recharge before trying to purchase.
    400 CommodityServiceCalling.Exception Failed to call commodity service. Failed to call commodity service return.
    400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. The module you purchased is not legal, please buy it again.
    400 RegionEndTimeDissolvedIndia Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. Hello customer, this area has been abolished.
    400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. Hello customer, this area has been abolished.
    400 Price.CommoditySys Commodity system call exception. Commodity system call exception.
    400 Pay.InsufficientBalance Insufficient available balance. Insufficient available balance.
    400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. There is a problem with the period you selected, please choose again.
    400 pay.noCreditCard Account not bound to credit card. -
    400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method. No payment method has been specified for your account. We recommend that you add a payment method.
    400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. Your basic information is not complete, please complete your basic information before operation.
    400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. Your account is abnormal, please contact customer service for details.
    400 BasicInfoUncompleted Your information is incomplete, Complete your information before the operation. -
    400 Api.NotSupport Specified api is not supported. The current interface does not support.
    400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. The DBInstanceId provided does not exist.
    400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type The current instance type does not support the specified storage type.
    400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
    400 KmsApiError User secret key invalid. The user key is invalid.
    400 System.SaleValidateFailed Sales expression validation system error. A system error occurs when the sales expression is verified.
    400 Abs.InvalidAccount.NotFound account is not found. The account does not exist.
    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.
    403 OrderStatus.UnPaid The specified db instance has unpaid order. The instance has an unpaid order. Please pay first and try again.
    403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. The scale-in target capacity cannot be less than the current storage space usage
    403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd. -
    403 InvalidUserOperatorPermission The user permission does not support this operation. The user is not authorized to perform this operation.
    403 InvalidVswitchId Specified conn vswitch id is not valid. -
    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.
    404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. The instance does not have permissions to access Key Management Service (KMS).
    500 ExternalFailure The request processing has failed due to external service failure. The request processing has failed due to external service failure.

    For a list of error codes, visit the Service error codes.

    Change history

    Change time Summary of changes Operation
    2024-05-22 The Error code has changed View Change Details