International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Documentation

DeleteSyncJob

Last updated: 2021-03-02 17:37:17

1. API Description

Domain name for API request: dts.tencentcloudapi.com.

This API is used to delete a disaster recovery sync task. Sync tasks that are running cannot be deleted.

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

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 parameter. The value used for this API: DeleteSyncJob.
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 ID of the disaster recovery sync task to be deleted

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting a sync task

Input Example

https://dts.tencentcloudapi.com/?Action=DeleteSyncJob
&JobId=sync-1r4qpcb1
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "e15f9b4c-9841-40d2-a28b-dea284a17315"
  }
}

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

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 Communication protocol error.
InvalidParameter A parameter error occurred.
ResourceNotFound.JobNotExist The migration task does not exist.

Was this page helpful?

Confirm

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Hide
Submit a TicketContact Us
Help