調用DeleteDtsJob接口釋放一個數據遷移、同步或訂閱實例。

調試

您可以在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：訂閱。

返回數據

名稱 類型 示例值 描述
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. 簽名已經過期，請更新簽名

訪問錯誤中心查看更多錯誤碼。