Deletes a data migration, data synchronization, or change tracking task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteDtsJob

The operation that you want to perform. Set the value to DeleteDtsJob.

DtsJobId String Yes l3m1213ye7l****

The ID of the data migration, data synchronization, or change tracking task.

DtsInstanceId String No dtsl3m1213ye7l****

The ID of the data migration, data synchronization, or change tracking instance.

SynchronizationDirection String No Forward

The synchronization direction. Valid values:

  • Forward: Data is synchronized from the source database to the destination database.
  • Reverse: Data is synchronized from the destination database to the source database.
Note
  • Default value: Forward.
  • You can set this parameter to Reverse to delete the reverse synchronization task only if the topology is two-way synchronization.
RegionId String No cn-beijing

The ID of the region in which the data migration or synchronization task resides. For more information, see List of supported regions.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code.

RequestId String 01B6F25-21E7-4484-99D5-3EF2625C****

The ID of the request.

ErrCode String InternalError

The error code returned if the call failed.

Success Boolean true

Indicates whether the call was successful.

ErrMessage String The Value of Input Parameter %s is not valid.

The error message returned if the call failed.

DynamicMessage String DtsJobId

The dynamic part in the error message. This parameter is used to replace the %s variable in the ErrMessage parameter.

Note If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified DtsJobId parameter is invalid.
DynamicCode String 403

The dynamic error code. This parameter will be removed in the future.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DeleteDtsJob
&DtsJobId=l3m1213ye7l****
&DtsInstanceId=dtsl3m1213ye7l****
&SynchronizationDirection=Forward
&RegionId=cn-beijing
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteDtsJobResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>01B6F25-21E7-4484-99D5-3EF2625C****</RequestId>
    <ErrCode>InternalError</ErrCode>
    <Success>true</Success>
    <ErrMessage>The Value of Input Parameter %s is not valid.</ErrMessage>
    <DynamicMessage>DtsJobId</DynamicMessage>
    <DynamicCode>403</DynamicCode>
</DeleteDtsJobResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "RequestId" : "01B6F25-21E7-4484-99D5-3EF2625C****",
  "ErrCode" : "InternalError",
  "Success" : true,
  "ErrMessage" : "The Value of Input Parameter %s is not valid.",
  "DynamicMessage" : "DtsJobId",
  "DynamicCode" : "403"
}

Error codes

Http status code Error code Error message Description
400 Throttling.User Request was denied due to user flow control. The error message returned because the number of requests exceeds the limit, and the request is rejected. Try again later.
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. The error message returned because the signature expired. Use a new signature.
500 ServiceUnavailable The request has failed due to a temporary failure of the server. The error message returned because the response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.

For a list of error codes, visit the API Error Center.