DeleteDtsJob - Data Transmission Service

Note You cannot release a subscription Data Transmission Service (DTS) instance.

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 Reverse Note The default value is 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 region ID of the Data Transmission Service (DTS) instance. For more information, see Supported regions.
JobType	String	No	MIGRATION	The type of the DTS task. Valid values: MIGRATION: data migration instance. SYNC: data synchronization instance. SUBSCRIBE: change tracking instance.
ZeroEtlJob	Boolean	No	true	This parameter is only for special services and not required.
ResourceGroupId	String	No	rg-aek26lwshij****	This parameter is only for special services and not required.

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 request failed.
Success	Boolean	true	Indicates whether the request was successful.
ErrMessage	String	The Value of Input Parameter %s is not valid.	The error message returned if the request failed.
DynamicMessage	String	DtsJobId	The dynamic part in the error message. The value of this parameter is used to replace %s in the value of ErrMessage. Note For example, if the return value of ErrMessage is The Value of Input Parameter %s is not valid and the return value of DynamicMessage is DtsJobId, the specified value of DtsJobId 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

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

For a list of error codes, see Error Codes.