调用SuspendDtsJob暂停一个数据迁移、同步或订阅任务。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 SuspendDtsJob

系统规定参数。取值：SuspendDtsJob。

DtsJobId String 是 l3m1213ye7l****

迁移、同步或订阅任务ID。

说明 可调用DescribeDtsJobs接口获取任务ID。
DtsInstanceId String 否 dtsl3m1213ye7l****

迁移、同步或订阅实例ID。
SynchronizationDirection String 否 Forward

同步方向，取值：

  • Forward：正向。
  • Reverse：反向。
说明
  • 默认取值为Forward。
  • 当数据同步实例的拓扑为双向时，才可以传入Reverse以暂停反向同步链路。
RegionId String 否 cn-hangzhou

DTS实例所在地域，详情请参见支持的地域列表。

返回数据

名称 类型 示例值 描述
HttpStatusCode Integer 200

状态码。
RequestId String 01B6F25-21E7-4484-99D5-3EF2625C****

请求ID。
ErrCode String InternalError

调用出错时返回的错误码。
Success Boolean true

请求是否成功。
ErrMessage String The Value of Input Parameter %s is not valid.

调用错误时返回的错误信息。
DynamicMessage String DtsJobId

动态错误信息，用于替换返回参数ErrMessage错误信息中的%s。

说明 如果ErrMessage返回The Value of Input Parameter %s is not valid，且DynamicMessage返回DtsJobId，则代表所传入的请求参数DtsJobId不合法。
DynamicCode String 403

动态错误码，本参数即将下线。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=SuspendDtsJob
&DtsJobId=l3m1213ye7l****
&<公共请求参数>

正常返回示例

XML格式 

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

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

JSON格式 

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

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

错误码

HttpCode 错误码 错误信息 描述
400 Throttling.User Request was denied due to user flow control. 由于请求频次达到阈值，请求被拒绝，请稍后重试。
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. 签名已经过期，请更新签名
500 ServiceUnavailable The request has failed due to a temporary failure of the server. 由于服务端响应超时或者不可用导致请求失败，请重试，重试后仍失败请联系技术支持。

访问错误中心查看更多错误码。