DescribeMigrateCheckJob

最后更新时间：2024-12-10 14:46:02

1. API Description

Domain name for API request: dts.intl.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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 Params. The value used for this API: DescribeMigrateCheckJob.
Version	Yes	String	Common Params. The value used for this API: 2018-03-30.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
JobId	Yes	String	Data migration task ID

3. Output Parameters

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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Getting the migration check result

Check succeeded

Input Example

https://dts.intl.tencentcloudapi.com/?Action=DescribeMigrateCheckJob
&JobId=dts-dau5czmd
&<Common request parameters>

Output Example

{
    "Response": {
        "Status": "finished",
        "ErrorCode": 0,
        "ErrorMessage": "ok",
        "Progress": "100",
        "CheckFlag": 1,
        "RequestId": "336448b0-2a45-4be4-8356-c245eab5784f"
    }
}

Example2 Getting the migration check result - 2

Check failed

Input Example

https://dts.intl.tencentcloudapi.com/?Action=DescribeMigrateCheckJob
&JobId=dts-1kl0iy0v
&<Common request parameters>

Output Example

{
    "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"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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	A communication protocol error occurred.
InvalidParameter	The parameter is incorrect.
ResourceNotFound.JobNotExist	The migration task does not exist.
UnauthorizedOperation.NotEnoughPrivileges	Authentication failed as there were no required permissions.

tencent cloud

Recent Pages