Check CDB Data SyncTask

Last updated: 2017-12-14 14:49:29

1. API Description

This API (CheckCdbDataSyncTask) is used to verify a data synchronization task. It can only be performed for the tasks with a status of "Configured" (status = 1).
Domain for API request: cdb.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is CheckCdbDataSyncTask.

Parameter Name Required Type Description
jobId Yes Int Data synchronization task ID. You can use API "Query List of Data synchronization Tasks" to query the task ID

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please refer to Common Error Codes on the Error Code page.
message String Module error message description depending on API.
codeDesc String Error description

4. Error Codes

The following error codes only include the business logic error codes for this API.

Error Code Error Message Error Description
9003 InvalidParameter Incorrect parameter
9013 InternalError System internal error
9634 OperationDenied Self-built synchronization is not allowed
9570 OperationDenied Process conflict. The task is not allowed
9572 InstanceNotExists Instance does not exist
9589 InternalError Task data error
9591 TaskNotExist Task does not exist
9592 OperationDenied Source MySQL or destination instance already has a running task
9631 OperationDenied Task data error

5. Example

Input

https://cdb.api.qcloud.com/v2/index.php?Action=CheckCdbDataSyncTask
&<Common request parameters>
&jobId=206

Output

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": []
}