使用ConfigureMigrationJob API配置資料移轉任務-Data Transmission Service-阿里雲

本介面調用成功後，將自動啟動資料移轉任務，您無需手動調用StartMigrationJob介面。

如果資料移轉任務未成功啟動，可能是由於預檢查失敗，您可以調用DescribeMigrationJobStatus介面查詢預檢查失敗的錯誤提示並修複問題。問題修複後，您需要手動調用StartMigrationJob介面來重啟資料移轉任務。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ConfigureMigrationJob	系統規定參數，取值：ConfigureMigrationJob。
DestinationEndpoint.InstanceType	String	是	RDS	目標庫的執行個體類型，取值： ECS：ECS上的自建資料庫。 LocalInstance：有公網IP的自建資料庫。 RDS：阿里雲RDS執行個體。 DRDS：阿里雲PolarDB-X執行個體。 MongoDB：阿里雲MongoDB執行個體。 Redis：阿里雲Redis執行個體。 PetaData：阿里雲HybridDB for MySQL執行個體。 POLARDB：阿里雲PolarDB MySQL、PolarDB PostgreSQL。 PolarDB_o：阿里雲PolarDB O引擎叢集。 AnalyticDB：阿里雲雲原生資料倉儲AnalyticDB MySQL 3.0和2.0版本。 Greenplum：阿里雲雲原生資料倉儲AnalyticDB PostgreSQL。
MigrationJobId	String	是	dtsl3m1213ye7l****	資料移轉執行個體ID，可以通過調用DescribeMigrationJobs介面查詢。
MigrationJobName	String	是	MySQL_TO_RDS	遷移任務名稱，不超過32個字元。建議配置具有業務意義的名稱（無唯一性要求），便於後續識別。
MigrationMode.DataIntialization	Boolean	是	true	是否進行全量資料移轉，取值： true：是。 false：否。說明 DTS對全量資料移轉的支援情況因資料庫類型不同而有所差異，詳情請參見支援的資料庫和遷移類型。
MigrationMode.DataSynchronization	Boolean	是	true	是否進行增量資料移轉，取值： true：是。 false：否。說明 DTS對增量資料移轉的支援情況因資料庫類型不同而有所差異，詳情請參見支援的資料庫和遷移類型。
MigrationMode.StructureIntialization	Boolean	是	true	是否進行結構遷移，取值： true：是。 false：否。說明 DTS對結構遷移的支援情況因資料庫類型不同而有所差異，詳情請參見支援的資料庫和遷移類型。
MigrationObject	String	是	[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]	待遷移的對象，格式為JSON串，且支援一定的Regex。更多相關介紹和樣本請參見遷移對象配置說明。
SourceEndpoint.InstanceType	String	是	RDS	源庫的執行個體類型，取值： RDS：阿里雲RDS執行個體。 ECS：ECS上的自建資料庫。 LocalInstance：有公網IP的自建資料庫。 Express：通過專線/VPN網關/Smart Access Gateway接入的自建資料庫。 dg：通過資料庫網關DG接入的自建資料庫。 cen：通過雲企業網CEN接入的自建資料庫。 MongoDB：阿里雲MongoDB執行個體。 POLARDB：阿里雲PolarDB MySQL、PolarDB PostgreSQL。 PolarDB_o：阿里雲PolarDB O引擎叢集。
RegionId	String	否	cn-hangzhou	資料移轉執行個體所在地區的ID，詳情請參見支援的地區列表。說明與目標庫所屬的地區ID保持一致。
SourceEndpoint.InstanceID	String	否	rm-bp1i99e8l7913****	源庫的執行個體ID。說明當SourceEndpoint.InstanceType取值為RDS、ECS、Express、MongoDB、POLARDB或PolarDB_o時，本參數才可用且必須傳入對應的執行個體ID（例如取值為ECS，則本參數傳入ECS執行個體的ID）。當SourceEndpoint.InstanceType取值為Express時，本參數傳入VPC ID（即專用網路ID）。
SourceEndpoint.EngineName	String	否	MySQL	源庫的資料庫類型，取值：MySQL、TiDB、SQLServer、PostgreSQL、Oracle、MongoDB、Redis、POLARDB、polardb_pg。說明當DestinationEndpoint.InstanceType取值為RDS、POLARDB、ECS、LocalInstance或Express時，本參數才可用且必須傳入。
SourceEndpoint.Region	String	否	cn-hangzhou	源庫所屬的地區ID。說明當SourceEndpoint.InstanceType取值為LocalInstance時，您可以傳入cn-hangzhou或者離自建資料庫地物理距離最近的地區ID，詳情請參見支援的地區列表。
SourceEndpoint.IP	String	否	172.16.88.***	源庫的串連地址。說明當SourceEndpoint.InstanceType取值為LocalInstance或Express時，本參數才可用且必須傳入。
SourceEndpoint.Port	String	否	3306	源庫的服務連接埠。說明當SourceEndpoint.InstanceType取值為ECS、LocalInstance或Express時，本參數才可用且必須傳入。
SourceEndpoint.OracleSID	String	否	testsid	Oracle資料庫的SID資訊。說明當SourceEndpoint.EngineName取值為Oracle，且Oracle資料庫為非RAC執行個體時，本參數才可用且必須傳入。
SourceEndpoint.DatabaseName	String	否	dtstestdatabase	待遷移的資料庫名稱或鑒權資料庫名稱。說明當SourceEndpoint.EngineName取值為PostgreSQL或MongoDB時，本參數才可用且必須傳入。當SourceEndpoint.EngineName取值為PostgreSQL時，傳入待遷移的資料庫名稱；取值為MongoDB時，傳入資料庫帳號的鑒權資料庫名稱。
SourceEndpoint.UserName	String	否	dtstestaccount	源庫的資料庫帳號。說明遷移不同的資料庫所需的許可權有所差異，詳情請參見遷移方案概覽中對應的配置案例。
SourceEndpoint.Password	String	否	Test123456	源庫資料庫帳號的密碼。
SourceEndpoint.OwnerID	String	否	140692647406****	源執行個體所屬的阿里雲帳號ID。說明僅在配置跨阿里雲帳號的資料移轉時本參數才可用，且必須傳入。
SourceEndpoint.Role	String	否	ram-for-dts	當源執行個體與目標執行個體所屬阿里雲帳號不同時，需傳入該參數，來指定源執行個體的授權角色，以允許目標執行個體阿里雲帳號訪問源執行個體的執行個體資訊。說明角色所需的許可權及授權方式，請參見跨阿里雲帳號資料移轉或同步時如何配置RAM授權。
DestinationEndpoint.InstanceID	String	否	rm-bp1r46452ai50****	目標執行個體ID。說明當DestinationEndpoint.InstanceType取值為RDS、ECS、MongoDB、Redis、DRDS、PetaData、OceanBase、POLARDB、PolarDB_o、AnalyticDB或Greenplum時，本參數才可用且必須傳入對應的執行個體ID（例如取值為ECS，則需要傳入ECS執行個體ID）。
DestinationEndpoint.EngineName	String	否	MySQL	目標庫的資料庫類型。取值：MySQL、DRDS、SQLServer、PostgreSQL、PPAS、MongoDB、Redis、POLARDB、polardb_pg 說明當DestinationEndpoint.InstanceType取值為RDS、POLARDB、ECS、LocalInstance或Express時，本參數才可用且必須傳入。
DestinationEndpoint.Region	String	否	cn-hangzhou	目標庫所屬的地區ID。說明當DestinationEndpoint.InstanceType取值為LocalInstance時，您可以傳入cn-hangzhou或者離自建資料庫地物理距離最近的地區ID，詳情請參見支援的地區列表。
DestinationEndpoint.IP	String	否	172.16.88.***	目標庫的串連地址。說明當DestinationEndpoint.InstanceType取值為LocalInstance或Express時，本參數才可用且必須傳入。
DestinationEndpoint.Port	String	否	3306	目標庫的服務連接埠。說明當DestinationEndpoint.InstanceType取值為ECS、LocalInstance或Express時，本參數才可用且必須傳入。
DestinationEndpoint.DataBaseName	String	否	dtstestdatabase	待遷入的資料庫名稱或鑒權資料庫名稱。說明當DestinationEndpoint.EngineName取值為PostgreSQL、DRDS或MongoDB時，本參數才可用且必須傳入。當DestinationEndpoint.EngineName取值為PostgreSQL或DRDS時，傳入待遷移的資料庫名稱；取值為MongoDB時，傳入資料庫帳號的鑒權資料庫名稱。
DestinationEndpoint.UserName	String	否	dtstestaccount	目標庫的資料庫帳號。說明遷移不同的資料庫所需的許可權有所差異，詳情請參見遷移方案概覽中對應的配置案例。
DestinationEndpoint.Password	String	否	Test123456	目標庫資料庫帳號的密碼。
MigrationReserved	String	否	{ "autoStartModulesAfterConfig": "none", "targetTableMode": 2 }	DTS預留參數，格式為JSON串，您可以傳入本參數實現特殊需求（例如是否自動啟動預檢查）。更多資訊，請參見MigrationReserved參數說明。
Checkpoint	String	否	111	增量資料移轉的啟動位點，格式為Unix時間戳記，單位為秒。
AccountId	String	否	12323344****	阿里雲主帳號ID，無需設定，該參數即將下線。
DestinationEndpoint.OracleSID	String	否	testsid	Oracle資料庫的SID資訊。說明當DestinationEndpoint.EngineName取值為Oracle，且Oracle資料庫為非RAC執行個體時，本參數才可用且必須傳入。

返回資料

名稱	類型	樣本值	描述
ErrCode	String	InternalError	調用出錯時返回的錯誤碼。
ErrMessage	String	The request processing has failed due to some unknown error.	調用錯誤時返回對應的錯誤資訊。
RequestId	String	40E35BD9-002E-4D63-9BE5-FBA48833****	請求ID。
Success	String	true	請求是否成功。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=ConfigureMigrationJob
&DestinationEndpoint.InstanceType=RDS
&MigrationJobId=dtsl3m1213ye7l****
&MigrationJobName=MySQL_TO_RDS
&MigrationMode.DataIntialization=true
&MigrationMode.DataSynchronization=true
&MigrationMode.StructureIntialization=true
&MigrationObject=[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]
&SourceEndpoint.InstanceType=RDS
&<公用請求參數>

正常返回樣本

XML格式

<ConfigureMigrationJobResponse>
      <RequestId>40E35BD9-002E-4D63-9BE5-FBA48833****</RequestId>
      <Success>true</Success>
</ConfigureMigrationJobResponse>

JSON格式

{
	"RequestId": "40E35BD9-002E-4D63-9BE5-FBA48833****",
	"Success": true
}

錯誤碼

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