Domain name for API request: dts.tencentcloudapi.com.
This API is used to get the check result and query check status and progress after a check is created.
If the check succeeds, you can call the StartMigrateJob API to start migration.
If the check fails, the reason can be queried. Please modify the migration configuration or adjust relevant parameters of the source/target instances through the ModifyMigrateJob API based on the error message.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dts.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeMigrateCheckJob. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-03-30. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| JobId | Yes | String | Data migration task ID |
| Parameter Name | Type | Description |
|---|---|---|
| Status | String | Check task status: unavailable, starting, running, finished |
| ErrorCode | Integer | Task error code |
| ErrorMessage | String | Task error message |
| Progress | String | Check task progress. For example, "30" means 30% completed |
| CheckFlag | Integer | Whether the check succeeds. 0: no; 1: yes; 3: not checked |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to get the migration check result (check succeeded).
https://dts.tencentcloudapi.com/?Action=DescribeMigrateCheckJob
&JobId=dts-dau5czmd
&<Common request parameters>{
"Response": {
"Status": "finished",
"ErrorCode": 0,
"ErrorMessage": "ok",
"Progress": "100",
"CheckFlag": 1,
"RequestId": "336448b0-2a45-4be4-8356-c245eab5784f"
}
}This example shows you how to get the migration check result (check failed).
https://dts.tencentcloudapi.com/?Action=DescribeMigrateCheckJob
&JobId=dts-1kl0iy0v
&<Common request parameters>{
"Response": {
"Status": "finished",
"ErrorCode": -1,
"ErrorMessage": "The selected table does not exist. Please select another one [the input parameter "table" was not found in the source instance]",
"Progress": "100",
"CheckFlag": 0,
"RequestId": "67b4cfcf-6957-48ae-b7ef-ba33209895e3"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.NotAllowOperation | This operation is prohibited. |
| InternalError.DatabaseError | Failed to access the database on the DTS platform. |
| InternalError.ProtocolError | Communication protocol error. |
| InvalidParameter | Invalid parameter. |
| ResourceNotFound.JobNotExist | The migration task does not exist. |
Was this page helpful?