DescribeCloudMigrationPrecheckResult - ApsaraDB RDS - Alibaba Cloud Documentation Center

Query the details about the assessment report for cloud migration to an instance.

Operation description

Supported database engines

PostgreSQL

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeCloudMigrationPrecheckResult	Read	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****
TaskId	long	No	The task ID. You can obtain the task ID from the response that is returned after you call the CreateCloudMigrationPrecheckTask operation to create the task.	439946016
TaskName	string	No	The task name. You can obtain the task name from the response that is returned after you call the CreateCloudMigrationPrecheckTask operation to create the task.	slf7w7wj3g
SourceIpAddress	string	No	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 an on-premises data center, enter the private IP address of the on-premises data center.	172.2.XX.XX
SourcePort	long	No	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
PageSize	long	Yes	The number of entries per page. Valid values: 30 to 100. Default value: 30.	30
PageNumber	long	Yes	The page number. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalSize	integer	The total number of entries returned.	1
RequestId	string	The ID of the request.	7E4A6E1B-789B-5F16-9736-39AA57FC7374
Items	object []	The details about the assessment report.
GmtCreated	string	The time when the task was created.	2022-02-25T06:57:41Z
GmtModified	string	The time when the task was modified.	2022-02-25T06:58:00Z
TaskId	long	The task ID.	440420798
TaskName	string	The task name.	lxbv6rtxno8
SourceCategory	string	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
SourceIpAddress	string	The private IP address that is used to connect to the self-managed PostgreSQL instance.	172.2.XX.XX
SourcePort	long	The port number that is used to connect to the self-managed PostgreSQL instance.	5432
SourceAccount	string	The username.	migratetest
SourcePassword	string	The password.	123456
TargetEip	string	A reserved parameter. The return value of this parameter is empty.	null
TargetInstanceName	string	The instance ID.	pgm-bp102g323jd4****
Detail	string	The content of the assessment report.	[Check rds empty]\nCheck rds databases: success\n[Check source connectivity]\nCheck ip connectable: success\nCheck port connectable: success\nCheck database connectable: success\nCheck account replication privilege: success\nCheck account createrole privilege: success\nCheck account monitor privilege: success\n[Check source version]\nCheck major version consistent: success\n[Check source glibc version]\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\n[Check disk size]\nCheck disk size enough: success\n[Check wal keep size]\nCheck wal keep size large enough: success\n[Check spec params]\nCheck if spec params too large: success\n [Check triggers]\nCheck triggers compatible: success\n[Check user functions]\nCheck user functions compatible: success\nMigrate check success
PageNumber	long	The page number.	1
PageSize	long	The number of entries returned per page.	10

Examples

Sample success responses

JSONformat

{
  "TotalSize": 1,
  "RequestId": "7E4A6E1B-789B-5F16-9736-39AA57FC7374",
  "Items": [
    {
      "GmtCreated": "2022-02-25T06:57:41Z",
      "GmtModified": "2022-02-25T06:58:00Z",
      "TaskId": 440420798,
      "TaskName": "lxbv6rtxno8",
      "SourceCategory": "ecsonvpc",
      "SourceIpAddress": "172.2.XX.XX",
      "SourcePort": 5432,
      "SourceAccount": "migratetest",
      "SourcePassword": "123456",
      "TargetEip": "null",
      "TargetInstanceName": "pgm-bp102g323jd4****",
      "Detail": "[Check rds empty]\\nCheck rds databases: success\\n[Check source connectivity]\\nCheck ip connectable: success\\nCheck port connectable: success\\nCheck database connectable: success\\nCheck account replication privilege: success\\nCheck account createrole privilege: success\\nCheck account monitor privilege: success\\n[Check source version]\\nCheck major version consistent: success\\n[Check source glibc version]\\nCheck source glibc version compatible: warning(warning:source glibc version is not compatible with rds pg)\\n[Check disk size]\\nCheck disk size enough: success\\n[Check wal keep size]\\nCheck wal keep size large enough: success\\n[Check spec params]\\nCheck if spec params too large: success\\n [Check triggers]\\nCheck triggers compatible: success\\n[Check user functions]\\nCheck user functions compatible: success\\n*Migrate check success*"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10
}

Error codes

HTTP status code	Error code	Error message	Description
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.

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