Queries the details about the cloud migration task of an ApsaraDB RDS for PostgreSQL instance.
Operation description
Debugging
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 Resourcesis 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:DescribeCloudMigrationResult | Read |
|
| 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 when you call the CreateCloudMigrationTask operation to create the task. | 440437220 |
| TaskName | string | No | The task name. You can obtain the task name from the response that is returned when you call the CreateCloudMigrationTask operation to create the task. | 362c6c7a-4d20-4eac-898c-1495ceab374c |
| SourceIpAddress | string | No | The private IP address that is used to connect to the self-managed PostgreSQL instance.
| 172.16.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 |
| PageNumber | long | Yes | The number of entries per page. | 10 |
| PageSize | long | Yes | The page number. | 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalSize": 1,
"RequestId": "1B983C48-9793-5EAA-8F7F-00EAEC517675",
"Items": [
{
"GmtCreated": "2022-02-25T08:53:13Z",
"GmtModified": "2022-03-01T06:39:51Z",
"TaskId": 440437220,
"TaskName": "362c6c7a-4d20-4eac-898c-1495ceab374c",
"MigrateStage": "switch",
"SourceCategory": "ecsonvpc",
"SourceIpAddress": "172.16.XX.XX",
"SourcePort": 5432,
"SourceAccount": "migratetest",
"SourcePassword": "123456",
"TargetEip": "null",
"TargetInstanceName": "pgm-bp102g323jd4****",
"ReplicationState": "streaming",
"ReplicationInfo": "{\\\"Status\\\":\\\"streaming\\\",\\\"ReceiveStartLsn\\\":\\\"0/3000000\\\",\\\"ReceivedTli\\\":\\\"1\\\",\\\"LatestEndTime\\\":\\\"2022-02-25 17:03:59.3344+08\\\",\\\"Synced\\\":\\\"true\\\",\\\"IsSlave\\\":\\\"true\\\",\\\"ReplayTimestamp\\\":\\\"null\\\",\\\"LastMsgSendTime\\\":\\\"2022-03-01 14:42:57.967537+08\\\",\\\"Conninfo\\\":\\\"user=migratetest password=******** channel_binding=prefer dbname=replication host=172.16.254.203 port=5432 application_name=rds_db_instance fallback_application_name=walreceiver sslmode=prefer sslcompression=1 sslsni=1 ssl_min_protocol_version=TLSv1.2 gssencmode=prefer krbsrvname=postgres target_session_attrs=any\\\",\\\"LastMsgReceiptTime\\\":\\\"2022-03-01 14:42:57.96727+08\\\",\\\"LatestEndLsn\\\":\\\"0/3000148\\\",\\\"ReceivedLsn\\\":\\\"0/3000148\\\",\\\"ReplayLsn\\\":\\\"0/3000148\\\",\\\"ReceiveStartTli\\\":\\\"1\\\",\\\"ReplayLag\\\":\\\"0\\\"}",
"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[Start RDS instance]\\n2022-02-25 17:00:29 --- Start RDS instance as slave for data replication\\n[Synchronize data]\\n2022-02-25 17:01:05 --- Synchronize data from source to RDS by streaming replication \\n",
"SwitchTime": "2022-03-01T06:40:51Z"
}
],
"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.