查詢遷移執行個體列表及各執行個體詳情 - Data Transmission Service

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	DescribeMigrationJobs	系統規定參數，取值：DescribeMigrationJobs。
Tag.N.Key	String	是	testkey1	標籤鍵，可以通過調用ListTagResources介面查詢。說明 N表示第幾個標籤的鍵。例如：Tag.1.Key表示第一個標籤的鍵；Tag.2.Key表示第二個標籤的鍵。可以同時傳入1~20個標籤鍵。該參數傳入時不允許傳入Null 字元串。
RegionId	String	否	cn-hangzhou	資料移轉執行個體所在地區的ID，詳情請參見支援的地區列表。
PageSize	Integer	否	30	每頁記錄的資料移轉執行個體的數量，取值：30、50、100，預設值為30。
PageNum	Integer	否	1	頁碼，取值為大於0且不超過Integer資料類型的最大值，預設值為1。
MigrationJobName	String	否	MySQL遷移	遷移執行個體名稱。說明支援模糊查詢。
AccountId	String	否	12323344****	阿里雲主帳號ID，無需設定，該參數即將下線。
Tag.N.Value	String	否	testvalue1	標籤的值，可以通過調用ListTagResources介面查詢。說明 N表示第幾個標籤的值。例如：Tag.1.Value表示第一個標籤的值；Tag.2.Value表示第二個標籤的值。可以同時傳入1~20個標籤值。允許傳入Null 字元串。

返回資料

名稱	類型	樣本值	描述
ErrCode	String	InternalError	調用出錯時返回的錯誤碼。
ErrMessage	String	The request processing has failed due to some unknown error.	調用錯誤時返回的錯誤資訊。
MigrationJobs	Array of MigrationJob		資料移轉執行個體列表和各遷移執行個體的詳情。
MigrationJob
DataInitialization	Struct		全量資料移轉情況。
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	全量資料移轉失敗的錯誤提示。
Percent	String	100	全量資料移轉進度，單位為百分比。
Progress	String	200001	已完成全量資料初始化的記錄數。
status	String	Finished	全量資料移轉狀態，取值包括： NotStarted：未啟動。 Migrating：遷移中。 Failed：遷移失敗。 Finished：遷移完成。
DataSynchronization	Struct		增量資料移轉情況。
Delay	String	0	增量資料移轉延遲，單位為秒。
ErrorMessage	String	任務失敗太久無法恢複	增量資料移轉失敗的錯誤提示。
Percent	String	95	增量資料移轉進度，單位為百分比。
status	String	Catched	增量資料移轉狀態，取值包括： NotStarted：未啟動。 Migrating：遷移中。 Failed：遷移失敗。 Finished：遷移完成。 Catched：無延遲。
DestinationEndpoint	Struct		目標執行個體的串連資訊。
DatabaseName	String	dtstestdata	目標執行個體中待遷移對象所屬資料庫的名稱。
EngineName	String	MySQL	目標執行個體的資料庫類型。
IP	String	172.16.88.***	目標執行個體的串連地址。
InstanceID	String	rm-bp1zc3iyqe3qw****	目標執行個體ID。
InstanceType	String	RDS	目標執行個體類型。
OracleSID	String	testsid	當目標執行個體的資料庫類型為Oracle時，才會返回該參數。
Port	String	3306	目標執行個體的資料庫服務連接埠。
UserName	String	dtstest	目標執行個體的資料庫帳號。
InstanceCreateTime	String	2021-06-22T09:02:13Z	遷移執行個體建立時間，yyyy-MM-ddTHH:mm:ssZ（UTC時間）。
JobCreateTime	String	2021-06-22T08:53:55Z	同步任務建立時間，yyyy-MM-ddTHH:mm:ssZ（UTC時間）。
MigrationJobClass	String	2xlarge	資料移轉執行個體的規格，傳回值為：small、medium、large、xlarge或2xlarge。更多規格說明，請參見資料移轉鏈路規格說明。
MigrationJobID	String	dtson2z28evm33****	資料移轉執行個體ID。
MigrationJobName	String	MySQL遷移	資料移轉執行個體名稱。
MigrationJobStatus	String	Migrating	遷移執行個體狀態，傳回值為： NotStarted：未啟動。 Prechecking：表示預檢查中。 PrecheckFailed：表示預檢查失敗。 Migrating：表示遷移中。 Suspending：表示暫停中。 MigrationFailed：表示遷移失敗。 Finished：表示完成。
MigrationMode	Struct		遷移類型。
DataInitialization	Boolean	true	是否遷移全量資料，取值： true：是。 false：否。
DataSynchronization	Boolean	true	是否遷移增量資料，取值： true：是。 false：否。
StructureInitialization	Boolean	true	是否執行結構遷移，取值： true：是。 false：否。
MigrationObject	Array of SynchronousObject		遷移對象。
SynchronousObject
DatabaseName	String	dtstestdata	源執行個體中待遷移對象所屬資料庫的名稱。
TableList	List	customer	遷移對象的表名。
WholeDatabase	String	false	是否遷移整庫，傳回值： true：是。 false：否。
PayType	String	PostPaid	遷移執行個體的付費類型，傳回值固定為PostPaid（隨用隨付）。
Precheck	Struct		預檢查情況。
Percent	String	100	預檢查整體進度，單位為百分比。
Status	String	Success	預檢查結果，傳回值： Success：通過。 Failed：未通過。
SourceEndpoint	Struct		源執行個體的串連資訊。
DatabaseName	String	dtstestdata	源執行個體中待遷移對象所屬資料庫的名稱。
EngineName	String	MySQL	源執行個體的資料庫類型。
IP	String	172.16.88.***	源執行個體的串連地址。
InstanceID	String	rm-bp1i99e8l7913****	源執行個體ID。
InstanceType	String	RDS	源執行個體類型。
OracleSID	String	testsid	當源執行個體的資料庫類型為Oracle時，才會返回該參數。
Port	String	3306	源執行個體的資料庫服務連接埠。
UserName	String	dtstest	源執行個體的資料庫帳號。
StructureInitialization	Struct		結構遷移情況。
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	結構遷移失敗的錯誤提示。
Percent	String	100	結構遷移進度，單位為百分比。
Progress	String	1	已完成結構遷移的表的數量。
status	String	Finished	結構遷移狀態，取值包括： NotStarted：未啟動。 Migrating：遷移中。 Failed：遷移失敗。 Finished：遷移完成。
Tags	Array of Tag		標籤集合。
Tag
Key	String	testkey1	標籤鍵。
Value	String	testvalue1	標籤鍵對應的標籤值。
PageNumber	Integer	1	頁碼。
PageRecordCount	Integer	30	當前頁可展示的最大記錄數。
RequestId	String	0ED4846D-ED60-435D-88C0-7EC0CE4D****	請求ID。
Success	String	true	請求是否成功。
TotalRecordCount	Long	300	阿里雲主帳號下所有合格資料移轉執行個體數量。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=DescribeMigrationJobs
&Tag.1.Key=testkey1
&<公用請求參數>

正常返回樣本

XML格式

<DescribeMigrationJobsResponse>
      <TotalRecordCount>300</TotalRecordCount>
      <PageRecordCount>30</PageRecordCount>
      <RequestId>0ED4846D-ED60-435D-88C0-7EC0CE4D****</RequestId>
      <PageNumber>1</PageNumber>
      <MigrationJobs>
            <MigrationJob>
                  <DataSynchronization>
                        <Percent>95</Percent>
                        <Delay>0</Delay>
                        <status>Catched</status>
                  </DataSynchronization>
                  <Precheck></Precheck>
                  <InstanceCreateTime>2021-06-22T09:02:13Z</InstanceCreateTime>
                  <JobCreateTime>2021-06-22T08:53:55Z</JobCreateTime>
                  <MigrationJobName>MySQL遷移</MigrationJobName>
                  <PayType>PostPaid</PayType>
                  <MigrationJobStatus>Migrating</MigrationJobStatus>
                  <MigrationMode>
                        <DataInitialization>true</DataInitialization>
                        <DataSynchronization>true</DataSynchronization>
                        <StructureInitialization>true</StructureInitialization>
                  </MigrationMode>
                  <MigrationJobID>dtson2z28evm33****</MigrationJobID>
                  <MigrationObject>
                        <SynchronousObject>
                              <DatabaseName>dtstest</DatabaseName>
                              <WholeDatabase>false</WholeDatabase>
                              <TableList>
                                    <Table>customer</Table>
                              </TableList>
                        </SynchronousObject>
                  </MigrationObject>
                  <DataInitialization>
                        <Progress>200001</Progress>
                        <Percent>100</Percent>
                        <status>Finished</status>
                  </DataInitialization>
                  <DestinationEndpoint>
                        <UserName>dtstest</UserName>
                        <InstanceID>rm-bp1zc3iyqe3qw****</InstanceID>
                        <InstanceType>RDS</InstanceType>
                        <EngineName>MySQL</EngineName>
                  </DestinationEndpoint>
                  <MigrationJobClass>2xlarge</MigrationJobClass>
                  <SourceEndpoint>
                        <UserName>dtstest</UserName>
                        <InstanceID>rm-bp1i99e8l7913****</InstanceID>
                        <InstanceType>RDS</InstanceType>
                        <EngineName>MySQL</EngineName>
                  </SourceEndpoint>
                  <StructureInitialization>
                        <Progress>1</Progress>
                        <Percent>100</Percent>
                        <status>Finished</status>
                  </StructureInitialization>
                  <Tags></Tags>
            </MigrationJob>
      </MigrationJobs>
      <Success>true</Success>
</DescribeMigrationJobsResponse>

JSON格式

{
	"TotalRecordCount": 300,
	"PageRecordCount": 30,
	"RequestId": "0ED4846D-ED60-435D-88C0-7EC0CE4D****",
	"PageNumber": 1,
	"MigrationJobs": {
		"MigrationJob": [
			{
				"DataSynchronization": {
					"Percent": "95",
					"Delay": "0",
					"status": "Catched"
				},
				"Precheck": {},
                "InstanceCreateTime": "2021-06-22T09:02:13Z",
				"JobCreateTime": "2021-06-22T08:53:55Z",
				"MigrationJobName": "MySQL遷移",
				"PayType": "PostPaid",
				"MigrationJobStatus": "Migrating",
				"MigrationMode": {
					"DataInitialization": true,
					"DataSynchronization": true,
					"StructureInitialization": true
				},
				"MigrationJobID": "dtson2z28evm33****",
				"MigrationObject": {
					"SynchronousObject": [
						{
							"DatabaseName": "dtstest",
							"WholeDatabase": false,
							"TableList": {
								"Table": [
									"customer"
								]
							}
						}
					]
				},
				"DataInitialization": {
					"Progress": "200001",
					"Percent": "100",
					"status": "Finished"
				},
				"DestinationEndpoint": {
					"UserName": "dtstest",
					"InstanceID": "rm-bp1zc3iyqe3qw****",
					"InstanceType": "RDS",
					"EngineName": "MySQL"
				},
				"MigrationJobClass": "2xlarge",
				"SourceEndpoint": {
					"UserName": "dtstest",
					"InstanceID": "rm-bp1i99e8l7913****",
					"InstanceType": "RDS",
					"EngineName": "MySQL"
				},
				"StructureInitialization": {
					"Progress": "1",
					"Percent": "100",
					"status": "Finished"
				},
				"Tags": {
					"Tag": []
				}
			}
		]
	},
	"Success": true
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
500	InternalError	The request processing has failed due to some unknown error.	系統錯誤

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