修改DTS同步任務 - Data Transmission Service

說明您可以根據需求在控制台進行相應的預配置，然後預覽對應配置的OpenAPI參數資訊，以協助您填寫請求參數。更多資訊，請參見預覽OpenAPI的請求參數。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ModifyDtsJob	系統規定參數。取值：ModifyDtsJob。
RegionId	String	否	cn-hangzhou	執行個體所在地區，詳情請參見支援的地區列表。
DtsInstanceId	String	是	dtsbi6e22ay243****	同步執行個體ID。
SynchronizationDirection	String	否	Forward	指定同步方向，取值： Forward：正向。 Reverse：反向。說明預設取值為Forward。只有當資料同步執行個體的同步拓撲為雙向同步時，才需要傳入本參數。
ClientToken	String	否	0c593ea1-3bea-11e9-b96b-88e9fe63****	保證請求等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken只支援ASCII字元，且不能超過64個字元。
DbList	Map	否	{"dtstest":{"name":"dtstest","all":true}}	修改後的同步對象，格式為JSON串。詳細定義，請參見遷移、同步或訂閱對象說明。說明原DbList會被新傳入的DbList覆蓋，請確保新傳入的DbList資料中包含所有需要同步的對象，否則可能會導致同步對象丟失，請謹慎修改。建議您提前調用DescribeDtsJobDetail查詢當前同步對象，然後根據業務需要輸入修改後的同步對象。例如，當前對象為表A、B，現需要新增對象表C，那麼您需要在本參數同時傳入表A、B、C。 DbList最多支援傳入10 MB的資料。
EtlOperatorColumnReference	String	否	{ "configKeyMap": [ { "moduleCode": "03", "etlOperatorColumnReference": "etlOperatorColumnReference", "etlOperatorSetting": "etlOperatorSetting" }, { "moduleCode": "07", "etlOperatorColumnReference": "etlOperatorColumnReference", "etlOperatorSetting": "etlOperatorSetting" } ], "amp.increment.replicator.compare.all.columns.enable": false, "srcNetType": "VPC", "etlOperatorColumnReference": { "MODIFY_TIME": [ { "datasynchron.test_timing_user_000": "user_create_date" }, { "datasynchron.test_timing_user_001": "user_create_date" }, { "datasynchron.test_timing_user_002": "user_create_date" }, { "datasynchron.test_timing_user_003": "user_create_date" } ] }, "destNetType": "VPC", "originalSrcDbInst": "sg-sit-db2-primary.mysql.polardb.rds.aliyuncs.com", "etlOperatorSetting": "adb_time_travel", "sjobUseJobTask": "1", "srcVpcNetMappingInst": "172.19.XXX.XXX:4261", "destVpcNetMappingInst": "172.19.XXX.XXX:4260", "useJobTask": "1" }	T+1業務專用的欄位，ETL運算元，為業務專用欄位。
ModifyTypeEnum	String	否	UPDATE_RESERVED	指示修改同步任務的方式，不填預設修改同步對象；填寫UPDATE_RESERVED為修改預留參數。
Reserved	String	否	{"definer": false,"syncArchitecture": "oneway","whitelist.dms.online.ddl.enable": false,"destSSL": "0","triggerMode": "manual","sqlparser.dms.original.ddl": true,"whitelist.ghost.online.ddl.enable": false,"privilegeMigration": false,"maxRetryTime": 43200,"srcSSL": "0","autoStartModulesAfterConfig": "none"}	DTS預留參數，更新方式為新增而非覆蓋，格式為MAP JSON串，您可以傳入本參數實現特殊需求（例如是否自動啟動預檢查）。使用方法與Reserve參數類似，詳情請參見Reserve參數說明。
FileOssUrl	String	否	http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_12185****43989_**********	同步檔案的OSS地址。
FilterTableName	String	否	testtable	需要過濾的表名。
StructureInitialization	Boolean	否	true	是否執行庫表結構遷移或初始化，取值： true：是。 false：否。
DataInitialization	Boolean	否	true	是否執行全量資料移轉或全量資料初始化，取值： true：是。 false：否。
DataSynchronization	Boolean	否	true	是否執行增量資料移轉或同步，取值： false：否。 true：是。
DtsJobId	String	否	fpx1149rw7p***	同步任務的ID，可調用DescribeDtsJobs查詢。
ZeroEtlJob	Boolean	否	false	是否無感整合（Zero-ETL）任務，取值： true：是。 false：否。
ResourceGroupId	String	否	rg-acfmzawhxxc****	資源群組ID。

返回資料

名稱	類型	樣本值	描述
Status	String	200	狀態代碼。
RequestId	String	1D6ECADF-C5E9-4C96-8811-77602B31****	請求ID。
DtsJobId	String	bi6e22a****	DTS任務ID。
ErrCode	String	InternalError	調用出錯時返回的錯誤碼。
Success	Boolean	true	請求是否成功。
ErrMessage	Boolean	true	調用出錯時返回的錯誤資訊。說明該參數的資料類型應為String，實際樣本值為The request processing has failed due to some unknown error.

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=ModifyDtsJob
&DtsInstanceId=dtsbi6e22ay243****
&DbList={"dtstest":{"name":"dtstest","all":true}}
&<公用請求參數>

正常返回樣本

XML格式

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

<ModifyDtsJobResponse>
    <DtsJobId>bi6e22a****</DtsJobId>
    <RequestId>1D6ECADF-C5E9-4C96-8811-77602B31****</RequestId>
    <Success>true</Success>
</ModifyDtsJobResponse>

JSON格式

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

{
  "DtsJobId" : "bi6e22a****",
  "RequestId" : "1D6ECADF-C5E9-4C96-8811-77602B31****",
  "Success" : true
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
403	OperationDenied.JobStatusModifying	jobs state is modifying, please wait sync subtask ends	該任務處於修改同步對象中（之前修改同步對象操作尚未完成），請等待該狀態結束
403	CheckStatus.InvalidInitStatus	Task has not been configured, please configure job first	任務尚未配置，修改任務之前請先配置任務
403	DTS.Msg.OperationDenied.JobStatusModifying	jobs state is modifying, please wait sync subtask ends	該任務處於修改同步對象中（之前修改同步對象操作尚未完成），請等待該狀態結束
403	DTS.Msg.CheckStatus.InvalidInitStatus	Task has not been configured, please configure job first	任務尚未配置，修改任務之前請先配置任務
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	簽名已經到期，請更新簽名
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.	由於服務端響應逾時或者不可用導致請求失敗，請重試，重試後仍失敗請聯絡支援人員。

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