Suspends multiple Data Transmission Service (DTS) tasks.

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 SuspendDtsJobs

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

DtsJobIds String Yes hfi12iv4z7e****

The ID of the data migration or data synchronization task.

Note
  • For multiple tasks, separate them with commas (,).
  • You can call the DescribeDtsJobs operation to query the task ID.
RegionId String No cn-hangzhou

The ID of the region in which the DTS instance resides. For more information, see List of supported regions.

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 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.
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 AD823BD3-1BA6-4117-A536-165CB280****

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=SuspendDtsJobs
&DtsJobIds=hfi12iv4z7e****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

<StartDtsJobResponse>
      <RequestId>AD823BD3-1BA6-4117-A536-165CB280****</RequestId>
      <HttpStatusCode>200</HttpStatusCode>
      <Success>true</Success>
</StartDtsJobResponse>

JSON format 

{
    "RequestId": "AD823BD3-1BA6-4117-A536-165CB280****",
    "HttpStatusCode": 200,
    "Success": true
}

Error codes

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