使用SuspendSynchronizationJob API暫停資料同步執行個體-Data Transmission Service-阿里雲

說明

調用本介面時，同步作業須處於同步中狀態。
暫停同步作業不能超過6個小時，否則將無法被再次啟動。
隨用隨付類型的同步作業即使處於暫停狀態，DTS依然會收取費用。這是由於DTS只是暫停向目標庫寫入資料，仍然會繼續拉取源庫的日誌以便重啟任務後快速恢複運行，因此還是會佔用來源資料庫的頻寬等資源。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	SuspendSynchronizationJob	系統規定參數，取值：SuspendSynchronizationJob。
SynchronizationJobId	String	是	dtsmr1q4mc2152****	資料同步執行個體ID，可以通過調用DescribeSynchronizationJobs介面查詢。
RegionId	String	否	cn-hangzhou	地區ID，傳入本參數來指定執行個體所在地區，詳情請參見支援的地區列表。
SynchronizationDirection	String	否	Forward	同步方向，取值： Forward：正向。 Reverse：反向。說明預設取值為Forward。當資料同步執行個體的拓撲為雙向時，才可以傳入Reverse以暫停反向同步鏈路。
AccountId	String	否	12323344****	阿里雲主帳號ID，無需設定，該參數即將下線。

返回資料

名稱	類型	樣本值	描述
ErrCode	String	InternalError	調用出錯時返回的錯誤碼。
ErrMessage	String	The request processing has failed due to some unknown error.	調用錯誤時返回對應的錯誤資訊。
RequestId	String	C306C198-7807-409D-930A-D6CE6C32****	請求ID。
Success	String	true	請求是否成功。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=SuspendSynchronizationJob
&SynchronizationJobId=dtsmr1q4mc2152****
&<公用請求參數>

正常返回樣本

XML格式

<SuspendSynchronizationJobResponse>
      <RequestId>C306C198-7807-409D-930A-D6CE6C32****</RequestId>
      <Success>true</Success>
</SuspendSynchronizationJobResponse>

JSON格式

{
	"RequestId": "C306C198-7807-409D-930A-D6CE6C32****",
	"Success": true
}

錯誤碼

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