調用DescribeMigrationJobs查詢數據遷移實例列表和各遷移實例的詳情。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeMigrationJobs

系統規定參數，取值：DescribeMigrationJobs。

Tag.N.Key String 是 testkey1

標簽鍵，可以通過調用ListTagResources接口查詢。

說明
  • N表示第幾個標簽的鍵。例如：Tag.1.Key表示第一個標簽的鍵；Tag.2.Key表示第二個標簽的鍵。可以同時傳入1~20個標簽鍵。
  • 該參數傳入時不允許傳入空字符串。
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個標簽值。
  • 允許傳入空字符串。

返回數據

名稱 類型 示例值 描述
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. 系統錯誤

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