调用DescribeMigrationJobStatus接口查询一个数据迁移实例的状态

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

请求参数

名称	类型	是否必选	示例值	描述


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeMigrationJobStatus	系统规定参数，取值：DescribeMigrationJobStatus。
MigrationJobId	String	是	dtsz2v12jfo309****	数据迁移实例ID，可以通过调用DescribeMigrationJobs接口查询。
RegionId	String	否	cn-hangzhou	数据迁移实例所在地域的ID，详情请参见支持的地域列表。
ClientToken	String	否	0c593ea1-3bea-11e9-b96b-88e9fe63****	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。
AccountId	String	否	12323344****	阿里云主账号ID，无需设置，该参数即将下线。

返回数据

名称	类型	示例值	描述


名称	类型	示例值	描述
DataInitializationStatus	Struct		全量数据迁移执行状态。
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	全量数据迁移失败的错误提示。
Percent	String	100	全量数据迁移进度，单位为百分比。
Progress	String	200001	已完成全量数据初始化的记录数。
Status	String	Finished	全量数据迁移状态，取值包括： NotStarted：未启动。 Migrating：迁移中。 Failed：迁移失败。 Finished：迁移完成。
DataSynchronizationStatus	Struct		增量数据迁移执行状态。
Checkpoint	String	1612507847	迁移最新一条增量数据的时间戳，格式为Unix时间戳，单位为秒。
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	目标实例类型。
Port	String	3306	目标实例的数据库服务端口。
UserName	String	dtstest	目标实例的数据库账号。
oracleSID	String	testsid	Oracle数据库的SID信息。说明当目标实例的数据库类型为Oracle时，才会返回该参数。
ErrCode	String	InternalError	调用出错时返回的错误码。
ErrMessage	String	The request processing has failed due to some unknown error.	调用错误时返回的错误信息。
MigrationJobClass	String	2xlarge	数据迁移实例的规格，返回值为：small、medium、large、xlarge或2xlarge。更多规格说明，请参见数据迁移链路规格说明。
MigrationJobId	String	dtsz2v12jfo309****	数据迁移实例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	String	[{\"DBName\":\"dtstestdata\",\"TableIncludes\":[{\"TableName\":\"customer\"}]}]	迁移对象。
PayType	String	PostPaid	迁移实例的付费类型，返回值固定为PostPaid（按量付费）。
PrecheckStatus	Struct		预检查情况。
Detail	Array of CheckItem		各预检查项的执行情况。
CheckItem
CheckStatus	String	Success	检查结果，返回值： Success：通过该项检查。 Failed：未通过该项检查。
ErrorMessage	String	Original error: Access denied for user 'dtstest'@'100.104.*.' (using password: YES)	预检查未通过的错误提示。说明当CheckStatus参数返回值为Failed时，才会返回本参数。
ItemName	String	CHECK_CONN_SRC	预检查项目。
RepairMethod	String	CHECK_ERROR_DEST_CONN_REPAIR2	预检查未通过时对应的修复方法。说明当CheckStatus参数返回值为Failed时，才会返回本参数。
Percent	String	100	预检查整体进度，单位为百分比。
Status	String	Finished	预检查状态，返回值： NotStarted：未启动。 Suspending：暂停中。 Checking：预检查中。 Failed：预检查失败。 Finished：预检查完成。
RequestId	String	A032E3B4-929B-48E9-97B9-37587CBF****	请求ID。
SourceEndpoint	Struct		源实例的连接信息。
DatabaseName	String	dtstestdatabase	源实例中待迁移对象所属数据库的名称。
EngineName	String	MySQL	源实例的数据库类型。
IP	String	172.16.88.***	源实例的连接地址。
InstanceId	String	rm-bp1i99e8l7913****	源实例ID。
InstanceType	String	RDS	源实例类型。 RDS：阿里云RDS实例。 ECS：ECS上的自建数据库。 LocalInstance：有公网IP的自建数据库。 Express：通过专线/VPN网关/智能网关接入的自建数据库。 MongoDB：阿里云MongoDB实例。 POLARDB：阿里云PolarDB for MySQL集群（该值仅适用于中国站）。
Port	String	3306	源实例的数据库服务端口。
UserName	String	dtstest	源实例的数据库账号。
oracleSID	String	dtstestdatabase	Oracle数据库的SID信息。说明当源实例的数据库类型为Oracle时，才会返回该参数。
StructureInitializationStatus	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：迁移完成。
Success	String	true	请求是否成功。
TaskId	String	z2v12jfo309****	数据迁移任务ID，可用于配置控制台任务详情页面的链接。说明迁移任务详情页的链接为：https://dts.console.aliyun.com/#/progress/z2v12jfo309/config/ 。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeMigrationJobStatus
&MigrationJobId=dtsta7w132u12h****
&<公共请求参数>

正常返回示例

XML格式

<DescribeMigrationJobStatusResponse>
      <TaskId>z2v12jfo309****</TaskId>
      <DataInitializationStatus>
            <Status>Finished</Status>
            <Progress>200001</Progress>
            <Percent>100</Percent>
      </DataInitializationStatus>
      <RequestId>A032E3B4-929B-48E9-97B9-37587CBF****</RequestId>
      <MigrationJobName>MySQL迁移</MigrationJobName>
      <PayType>PostPaid</PayType>
      <MigrationJobStatus>Migrating</MigrationJobStatus>
      <Success>true</Success>
      <MigrationMode>
            <structureInitialization>true</structureInitialization>
            <dataSynchronization>true</dataSynchronization>
            <dataInitialization>true</dataInitialization>
      </MigrationMode>
      <MigrationJobId>dtsz2v12jfo309****</MigrationJobId>
      <PrecheckStatus>
            <Status>Finished</Status>
            <Percent>100</Percent>
            <Detail>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_CONN_SRC</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_AUTH_SRC</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_CONN_DEST</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_AUTH_DEST</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_ON</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_MODE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_ROW_IMAGE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SERVER_ID</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_EXIST</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_ENGINE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_MYSQL_PASSOWRD_FORMAT</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SRC</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SQL_MODE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SAME_USER</ItemName>
                  </CheckItem>
            </Detail>
      </PrecheckStatus>
      <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>
      <DataSynchronizationStatus>
            <Status>Catched</Status>
            <Checkpoint>1612507847</Checkpoint>
            <Percent>95</Percent>
            <Delay>0</Delay>
      </DataSynchronizationStatus>
      <StructureInitializationStatus>
            <Status>Finished</Status>
            <Progress>1</Progress>
            <Percent>100</Percent>
      </StructureInitializationStatus>
</DescribeMigrationJobStatusResponse>

JSON格式

{
	"TaskId": "z2v12jfo309****",
    "DataInitializationStatus": {
		"Status": "Finished",
		"Progress": "200001",
		"Percent": "100"
	},
	"RequestId": "A032E3B4-929B-48E9-97B9-37587CBF****",
	"MigrationJobName": "MySQL迁移",
	"PayType": "PostPaid",
	"MigrationJobStatus": "Migrating",
	"Success": true,
	"MigrationMode": {
		"structureInitialization": true,
		"dataSynchronization": true,
		"dataInitialization": true
	},
	"MigrationJobId": "dtsz2v12jfo309****",
	"PrecheckStatus": {
		"Status": "Finished",
		"Percent": "100",
		"Detail": {
			"CheckItem": [
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_CONN_SRC"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_AUTH_SRC"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_CONN_DEST"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_AUTH_DEST"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_BINLOG_ON"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_BINLOG_MODE"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_BINLOG_ROW_IMAGE"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_SERVER_ID"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_BINLOG_EXIST"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_ENGINE"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_MYSQL_PASSOWRD_FORMAT"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_SRC"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_SQL_MODE"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_SAME_USER"
				}
			]
		}
	},
	"DestinationEndpoint": {
		"UserName": "dtstest",
		"InstanceId": "rm-bp1zc3iyqe3qw****",
		"InstanceType": "RDS",
		"EngineName": "MySQL"
	},
	"MigrationJobClass": "2xlarge",
	"SourceEndpoint": {
		"UserName": "dtstest",
		"InstanceId": "rm-bp1i99e8l7913****",
		"InstanceType": "RDS",
		"EngineName": "MySQL"
	},
	"DataSynchronizationStatus": {
		"Status": "Catched",
		"Checkpoint": "1612507847",
		"Percent": "95",
		"Delay": "0"
	},
	"StructureInitializationStatus": {
		"Status": "Finished",
		"Progress": "1",
		"Percent": "100"
	}
}

错误码

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