Del CDB Data SyncTask

Last updated: 2017-12-14 14:51:14

PDF

1. API Description

This API (DelCdbDataSyncTask) is used to delete a data migration task. It can only be performed for the non-running tasks. The relevant statuses include Not Configured (status = 0), Configured (status = 1), Verification Failed (status = 3), Verification Succeeded (status = 4), Synchronization Failed (status = 8) and Synchronization Succeeded (status = 9).
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 DelCdbDataSyncTask.

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
data Array Returned data

4. Example

Input

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

Output

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