全部產品
Search
文件中心

Data Transmission Service:重設DTS任務

更新時間:Feb 10, 2025

調用ResetDtsJob重設一個資料同步或訂閱任務。

說明 清空資料同步或訂閱任務配置後,原先的任務就會被刪除,DTS將重新建立一個未配置的任務,您需要調用介面ConfigureDtsJob重新設定該任務。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱

類型

是否必選

樣本值

描述

Action String ResetDtsJob

系統規定參數。取值:ResetDtsJob

DtsJobId String l3m1213ye7l****

同步或訂閱任務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=ResetDtsJob
&DtsJobId=l3m1213ye7l****
&<公用請求參數>

正常返回樣本

XML格式

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

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

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. 由於服務端響應逾時或者不可用導致請求失敗,請重試,重試後仍失敗請聯絡支援人員。

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