调用StopDtsJob结束一个数据迁移、同步或订阅任务。

调试

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

请求参数

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

系统规定参数。取值:StopDtsJob

DtsJobId String l3m1213ye7l****

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

DtsInstanceId String dtsl3m1213ye7l****

迁移、同步或订阅实例ID。

SynchronizationDirection String Forward

同步方向,取值:

  • Forward:正向。
  • Reverse:反向。
说明
  • 默认取值为Forward
  • 当数据同步实例的拓扑为双向时,才可以传入Reverse以结束反向同步链路。

返回数据

名称 类型 示例值 描述
DynamicCode String 403

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

DynamicMessage String DtsJobId

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

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

调用出错时返回的错误码。

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

调用错误时返回的错误信息。

HttpStatusCode Integer 200

状态码。

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

请求ID。

Success Boolean true

请求是否成功。

示例

请求示例

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

正常返回示例

XML格式

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

JSON格式

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

错误码

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