Pre-checks a data import task for an ApsaraDB RDS for MySQL instance that uses native replication.
Operation description
This operation runs a pre-check before you import data to an ApsaraDB RDS for MySQL instance that uses native replication. It verifies connectivity and configuration to ensure a successful import.
Try it now
Test
RAM authorization
Request syntax
GET HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. You can call the DescribeRegions operation to query the available regions. |
cn-hangzhou |
| Host |
string |
Yes |
The IP address of the source MySQL database. |
192.168.10.1 |
| Port |
integer |
Yes |
The port number of the source MySQL database. |
3306 |
| StreamPort |
integer |
Yes |
The backup transfer port number. |
9999 |
| User |
string |
Yes |
The username for the source MySQL database account. |
myadmin |
| Password |
string |
Yes |
The password for the source MySQL database account. The value must be Base64-encoded. |
UGFzc3dvcmQxMjMK |
| SourcePlatform |
string |
No |
The platform where the source database is located.
|
ECS |
| SourceInstanceId |
string |
No |
The ID of the source ECS instance. |
i-wz9ff3acy500io5wdf5s |
| XtrabackupPath |
string |
No |
The path to the Xtrabackup tool on the source. |
/usr/local/bin/xtrabackup |
| DbInstanceId |
string |
Yes |
The ID of the destination ApsaraDB RDS instance. You can call the DescribeDBInstances operation to query for instance IDs. |
rm-sdfljk123**** |
| EstimatedSize |
integer |
No |
The estimated size of the source database, in GB. |
100 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response body. |
||
| RequestId |
string |
The ID of the request. |
08A3B71B-FE08-4B03-974F-CC7EA6DB1828 |
| TaskId |
integer |
The ID of the pre-check task. |
12345 |
Examples
Success response
JSON format
{
"RequestId": "08A3B71B-FE08-4B03-974F-CC7EA6DB1828\t",
"TaskId": 12345
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | INVALID_SOURCE_INSTANCE.RDS_CUSTOM | Source RdsCustom instance is not valid to import, please check instance attributes. | The source RdsCustom instance cannot be used for RDS data import. Check the instance properties. |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | This operation is not supported for the database engine of the instance. |
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | The operation failed. The RDS instance is not in a ready state. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.