使用DeleteDtsJob API释放DTS实例-数据传输服务-阿里云

说明包年包月的DTS实例不支持通过API释放，您可以通过退订的方式进行释放。更多信息，请参见释放DTS实例。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DeleteDtsJob	系统规定参数。取值：DeleteDtsJob。
DtsJobId	String	是	l3m1213ye7l****	迁移、同步或订阅任务ID。
DtsInstanceId	String	否	dtsl3m1213ye7l****	迁移、同步或订阅实例ID。
SynchronizationDirection	String	否	Forward	同步方向，取值： Forward：正向。 Reverse：反向。说明默认取值为Forward。当数据同步实例的拓扑为双向时，才可以传入Reverse以释放反向同步链路。
RegionId	String	否	cn-beijing	数据迁移或同步实例所在地域的id，详情请参见支持的地域列表。
JobType	String	否	MIGRATION	DTS实例的任务类型，取值： MIGRATION：迁移。 SYNC：同步。 SUBSCRIBE：订阅。
ZeroEtlJob	Boolean	否	true	特殊业务专用字段，无需传参。
ResourceGroupId	String	否	rg-aek26lwshij****	特殊业务专用字段，无需传参。

返回数据

名称	类型	示例值	描述
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=DeleteDtsJob
&DtsJobId=l3m1213ye7l****
&DtsInstanceId=dtsl3m1213ye7l****
&SynchronizationDirection=Forward
&RegionId=cn-beijing
&公共请求参数

正常返回示例

XML格式

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格式

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"
}

错误码

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

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