全部產品
Search
文件中心

Data Transmission Service:修改同步對象

更新時間:Feb 08, 2025

調用ModifySynchronizationObject介面修改資料同步執行個體中的同步對象。

說明 調用本介面時,資料同步執行個體需處於未啟動或同步中狀態。

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String ModifySynchronizationObject

系統規定參數,取值:ModifySynchronizationObject

SynchronizationJobId String dtskfq1149w254****

資料同步執行個體ID,可以通過調用DescribeSynchronizationJobs介面查詢。

SynchronizationObjects String [{"DBName": "dtstestdata"}]

修改後的同步對象,格式為JSON串且支援一定的Regex,詳細說明請參見同步對象配置說明

RegionId String cn-hangzhou

地區ID,傳入本參數來指定執行個體所在地區,詳情請參見支援的地區列表

SynchronizationDirection String Forward

指定同步方向,取值:

  • Forward:正向。
  • Reverse:反向。
說明
  • 預設取值為Forward
  • 只有當資料同步執行個體的同步拓撲為雙向同步時,才需要傳入本參數。
AccountId String 12323344****

阿里雲主帳號ID,無需設定,該參數即將下線。

返回資料

名稱 類型 樣本值 描述
ErrCode String InternalError

調用出錯時返回的錯誤碼。

ErrMessage String The request processing has failed due to some unknown error.

調用錯誤時返回對應的錯誤資訊。

RequestId String 902DDCDE-C755-4458-85DA-DF9A323C****

請求ID。

Success String true

請求是否成功。

TaskId String tl911uvi25z****

任務ID,您可以根據此參數調用DescribeSynchronizationObjectModifyStatus介面查詢同步對象變更的狀態及進度。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=ModifySynchronizationObject
&SynchronizationJobId=dtskfq1149w254****
&SynchronizationObjects=[{"DBName": "dtstestdata"}]
&<公用請求參數>

正常返回樣本

XML格式

<ModifySynchronizationObjectResponse>
      <TaskId>tl911uvi25z****</TaskId>
      <RequestId>902DDCDE-C755-4458-85DA-DF9A323C****</RequestId>
      <Success>true</Success>
</ModifySynchronizationObjectResponse>

JSON格式

{
	"TaskId": "tl911uvi25z****",
	"RequestId": "902DDCDE-C755-4458-85DA-DF9A323C****",
	"Success": true
}

錯誤碼

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