全部產品
Search
文件中心

Data Transmission Service:結束DTS任務

更新時間:Feb 10, 2025

調用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
}

錯誤碼

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