Stops 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 StopDtsJob

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

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
  • Default value: Forward.
  • You can set this parameter to Reverse to stop the reverse synchronization task only when the topology is two-way synchronization.

Response parameters

Parameter Type Example Description
DynamicCode String 403

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

DynamicMessage String DtsJobId

The dynamic error message, which is used to replace %s 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.
ErrCode String InternalError

The error code returned if the call failed.

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

The error message returned if the call failed.

HttpStatusCode Integer 200

The HTTP status code.

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

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=StopDtsJob
&DtsJobId=l3m1213ye7l****
&<Common request parameters>

Sample success responses

XML format 

<StopDtsJobResponse>
      <RequestId>01B6F25-21E7-4484-99D5-3EF2625C****</RequestId>
      <HttpStatusCode>200</HttpStatusCode>
      <Success>true</Success>
</StopDtsJobResponse>

JSON format 

{
    "RequestId":"01B6F25-21E7-4484-99D5-3EF2625C****",
    "HttpStatusCode":200,
    "Success":true
}

Error codes

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