配置同步執行個體 - Data Transmission Service

調用本介面前，已調用CreateSynchronizationJob介面建立了資料同步執行個體。

說明

本介面調用成功後，資料同步執行個體會自動啟動並執行預檢查，您無需調用StartSynchronizationJob介面來啟動。
如果資料同步執行個體沒有被成功啟動，可能是預檢查失敗，您可以調用DescribeSynchronizationJobStatus介面查詢資料同步執行個體的狀態，擷取預檢查失敗的錯誤提示並進行參數調整。調整完成後，您可以調用StartSynchronizationJob介面來重啟資料同步執行個體。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ConfigureSynchronizationJob	系統規定參數，取值：ConfigureSynchronizationJob。
DataInitialization	Boolean	是	true	是否執行全量資料初始化，取值： true：是。 false：否。說明預設取值：true。
StructureInitialization	Boolean	是	true	是否執行結構初始化，取值： true：是。 false：否。說明預設取值：true。
SynchronizationJobId	String	是	dtsz4ao1dor13d****	資料同步執行個體ID，可以通過調用DescribeSynchronizationJobs介面查詢。
SynchronizationObjects	String	是	[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]	同步對象，格式為JSON串且支援一定的Regex，詳細說明，請參見同步對象配置說明。
RegionId	String	否	cn-hangzhou	資料同步執行個體所在地區的ID，詳情請參見支援的地區列表。
SynchronizationJobName	String	否	MySQL同步	同步任務名稱。說明建議配置具有業務意義的名稱（無唯一性要求），便於後續識別。
SynchronizationDirection	String	否	Forward	同步方向，取值： Forward：正向。 Reverse：反向。說明預設取值為Forward。只有當資料同步執行個體的同步拓撲為雙向同步時，本參數傳入Reverse才會生效。
SourceEndpoint.InstanceId	String	否	rm-bp1i99e8l7913****	源執行個體ID。
SourceEndpoint.InstanceType	String	否	RDS	源執行個體類型，取值為： RDS：阿里雲RDS執行個體。 Redis：阿里雲Redis執行個體。 PolarDB：阿里雲PolarDB叢集（僅支援MySQL或相容Oracle文法的引擎）。 ECS：ECS上的自建資料庫。 Express：通過專線接入的自建資料庫。 dg：通過資料庫網關DG接入的自建資料庫。 cen：通過雲企業網CEN接入的自建資料庫。說明預設取值為RDS。
SourceEndpoint.IP	String	否	172.16.88.***	源庫的IP地址。說明當SourceEndpoint.InstanceType取值為ECS、Express、dg或cen時，本參數才可用且必須傳入。
SourceEndpoint.Port	String	否	3306	源庫的資料庫服務連接埠。說明當SourceEndpoint.InstanceType取值為ECS、Express、dg或cen時，本參數才可用且必須傳入。
SourceEndpoint.UserName	String	否	dtstestaccount	源庫的資料庫帳號。說明當SourceEndpoint.InstanceType取值為ECS、Express、dg或cen時，本參數才可用且必須傳入。當SourceEndpoint.InstanceType取值為Redis時，本參數無需傳入。同步不同的資料庫所需的許可權有所差異，詳情請參見DTS資料同步方案概覽中對應的配置案例。
SourceEndpoint.Password	String	否	Test123456	源庫資料庫帳號密碼。說明當SourceEndpoint.InstanceType取值為ECS、Express、dg或cen時，本參數必須傳入。
DestinationEndpoint.InstanceId	String	否	rm-bp1r46452ai50****	同步目標執行個體的執行個體ID 說明當DestinationEndpoint.InstanceType取值為MaxCompute或DataHub時，本參數傳入MaxCompute執行個體或DataHub的Project名稱。當目標執行個體為阿里雲AnalyticDB for MySQL時，傳入AnalyticDB for MySQL的叢集ID。
DestinationEndpoint.InstanceType	String	否	RDS	目標執行個體類型，取值為： Redis：阿里雲Redis執行個體。 RDS：阿里雲RDS執行個體。 PolarDB：阿里雲PolarDB叢集（僅支援MySQL或相容Oracle文法的引擎）。 ECS：ECS上的自建資料庫。 Express：通過專線接入的本機資料庫。 DataHub：阿里雲DataHub執行個體。 MaxCompute：阿里雲MaxCompute執行個體。 AnalyticDB：雲原生資料倉儲AnalyticDB MySQL 3.0和2.0版本。 Greenplum：雲原生資料倉儲ADB PostgreSQL版（原AnalyticDB for PostgreSQL）。說明預設取值為RDS。
DestinationEndpoint.IP	String	否	172.16.88.***	目標庫的IP地址。說明當DestinationEndpoint.InstanceType取值為Express、dg或cen時，本參數必須傳入本參數才可用且必須傳入。
DestinationEndpoint.Port	String	否	3306	目標庫的資料庫服務連接埠。說明當DestinationEndpoint.InstanceType取值為ECS、Express、dg或cen時，本參數才可用且必須傳入。
DestinationEndpoint.UserName	String	否	dtstestaccount	目標庫的資料庫帳號。說明同步不同的資料庫所需的許可權有所差異，詳情請參見DTS資料同步方案概覽中對應的配置案例。當DestinationEndpoint.InstanceType取值為ECS、Express、dg或cen時，本參數必須傳入。當DestinationEndpoint.InstanceType取值為RDS且資料庫版本為MySQL 5.5或MySQL 5.6，無需傳入本參數和DestinationEndpoint.Password參數。當DestinationEndpoint.InstanceType取值為Redis時，無需傳入本參數。
DestinationEndpoint.Password	String	否	Test654321	目標庫資料庫帳號密碼。說明當DestinationEndpoint.InstanceType取值為ECS、Express、dg或cen時，本參數必須傳入。
SourceEndpoint.OwnerID	String	否	140692647406****	源RDS執行個體所屬的阿里雲帳號ID。說明傳入本參數即代表執行跨阿里雲帳號的資料同步，同時您還需要傳入SourceEndpoint.Role參數。
SourceEndpoint.Role	String	否	ram-for-dts	源執行個體所屬雲帳號配置的角色名稱。說明執行跨阿里雲帳號的資料同步時須傳入本參數，該角色所需的許可權及授權方式請參見跨阿里雲帳號資料移轉或同步時如何配置RAM授權。
PartitionKey.ModifyTime_Year	Boolean	否	true	設定增量日誌表是否包含以累加式更新時間對應年份資訊定義的分區，取值：true或false。說明當DestinationEndpoint.InstanceType參數取值為Maxcompute時，本參數才可用。
PartitionKey.ModifyTime_Month	Boolean	否	true	設定增量日誌表是否包含以累加式更新時間對應月份資訊定義的分區，取值：true或false。說明當DestinationEndpoint.InstanceType參數取值為Maxcompute時，本參數才可用。
PartitionKey.ModifyTime_Day	Boolean	否	true	設定增量日誌表是否包含以累加式更新時間對應日期資訊定義的分區，取值：true或false。說明當DestinationEndpoint.InstanceType參數取值為Maxcompute時，本參數才可用。
PartitionKey.ModifyTime_Hour	Boolean	否	true	設定增量日誌表是否包含以累加式更新時間對應小時資訊定義的分區，取值：true或false。說明當DestinationEndpoint.InstanceType參數取值為Maxcompute時，本參數才可用。
PartitionKey.ModifyTime_Minute	Boolean	否	true	設定增量日誌表是否包含以累加式更新時間對應分鐘資訊定義的分區，取值：true或false。說明當DestinationEndpoint.InstanceType參數取值為Maxcompute時，本參數才可用。
MigrationReserved	String	否	{ "autoStartModulesAfterConfig": "none", "targetTableMode": 2 }	DTS預留參數，格式為JSON串，您可以傳入本參數實現特殊需求（例如是否自動啟動預檢查）。更多資訊，請參見MigrationReserved參數說明。說明如在Redis企業版執行個體間的資料同步可使用該參數，更多資訊，請參見調用OpenAPI配置Redis企業版執行個體間單向或雙向資料同步。
Checkpoint	String	否	1610540493	同步位點。
AccountId	String	否	12323344****	阿里雲主帳號ID，無需設定，該參數即將下線。
SourceEndpoint.DatabaseName	String	否	dtstestdata	源執行個體中的同步對象所屬資料庫名稱。
DestinationEndpoint.DataBaseName	String	否	dtstestdata	目標執行個體中的同步對象所屬資料庫名稱。

返回資料

名稱	類型	樣本值	描述
ErrCode	String	InternalError	調用出錯時返回的錯誤碼。
ErrMessage	String	The request processing has failed due to some unknown error.	調用錯誤時返回對應的錯誤資訊。
RequestId	String	2690E467-7773-43BC-A009-370EE2E7****	請求ID。
Success	String	true	請求是否成功。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=ConfigureSynchronizationJob
&DataInitialization=true
&StructureInitialization=true
&SynchronizationJobId=dtsz4ao1dor13d****
&SynchronizationObjects=[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]
&<公用請求參數>

正常返回樣本

XML格式

<ConfigureSynchronizationJobResponse>
      <RequestId>2690E467-7773-43BC-A009-370EE2E7****</RequestId>
      <Success>true</Success>
</ConfigureSynchronizationJobResponse>

JSON格式

{
	"RequestId": "2690E467-7773-43BC-A009-370EE2E7****",
	"Success": true
}

錯誤碼

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