查询迁移实例列表及各实例详情 - 数据传输服务 DTS

调试

您可以在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.	系统错误

访问错误中心查看更多错误码。