调用DescribeMigrationJobDetail接口查询数据迁移任务执行详情。

调用本接口时,数据迁移任务需处于迁移中、迁移失败、暂停或迁移完成状态。

调试

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

请求参数

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

系统规定参数,取值:DescribeMigrationJobDetail

MigrationJobId String dtsta7w132u12h****

数据迁移实例ID,可以通过调用DescribeMigrationJobs接口查询。

RegionId String cn-hangzhou

数据迁移实例所在地域的ID,详情请参见支持的地域列表

PageSize Integer 30

每页记录数,取值: 3050100,默认值为30

PageNum Integer 1

页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1

MigrationMode.StructureInitialization Boolean true

是否查询结构迁移详情,取值:

  • true:是。
  • false:否。
    说明 默认值为false
MigrationMode.DataInitialization Boolean true

是否查询全量数据迁移详情,取值:

  • true:是。
  • false:否。
    说明 默认值为false
MigrationMode.DataSynchronization Boolean true

是否查询增量数据迁移详情,取值:

  • true:是。
  • false:否。
    说明 默认值为false
ClientToken String 0c593ea1-3bea-11e9-b96b-88e9fe63****

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

AccountId String 12323344****

阿里云主账号ID,无需设置,该参数即将下线。

返回数据

名称 类型 示例值 描述
DataSynchronizationDetailList Array of DataSynchronizationDetail

增量数据迁移执行详情。

DataSynchronizationDetail
DestinationOwnerDBName String dtstestdata

目标实例中迁移对象所属数据库的名称。

ErrorMessage String 任务失败太久 无法恢复

增量数据迁移失败的错误提示。

SourceOwnerDBName String dtstestdata

源实例中迁移对象所属数据库的名称。

Status String Migrating

增量数据迁移状态,返回值:

  • NotStarted:未启动。
  • Migrating:迁移中。
  • Failed:迁移失败。
  • Finished:迁移完成。
TableName String customer

待迁移对象的表名。

DataInitializationDetailList Array of DataInitializationDetail

全量数据迁移执行详情。

DataInitializationDetail
DestinationOwnerDBName String dtstestdata

目标实例中迁移对象所属数据库的名称。

ErrorMessage String java.lang.NumberFormatException: For input string: ""

全量数据迁移失败的错误提示。

FinishRowNum String 200001

已迁移的记录数。

MigrationTime String 0.0

全量数据迁移的耗时。

SourceOwnerDBName String dtstestdata

源实例中迁移对象所属数据库的名称。

Status String Finished

全量数据迁移状态,返回值:

  • NotStarted:未启动。
  • Migrating:迁移中。
  • Failed:迁移失败。
  • Finished:迁移完成。
TableName String customer

待迁移对象的表名。

TotalRowNum String 201477

需迁移的总记录数。

ErrCode String InternalError

调用出错时返回的错误码。

ErrMessage String The request processing has failed due to some unknown error.

调用错误时返回的错误信息。

PageNumber Integer 1

页码。

PageRecordCount Integer 30

一页最多可展示的迁移实例数量。

RequestId String 0AE3CD0B-4148-426F-A90E-952467CC****

请求ID。

StructureInitializationDetailList Array of StructureInitializationDetail

结构迁移执行详情。

StructureInitializationDetail
ConstraintList Array of StructureInitializationDetail

迁移对象对应的约束(例如索引、外键等)。

说明 只有当ObjectTypeTable,且迁移对象有约束时,才会返回本参数。
StructureInitializationDetail
DestinationOwnerDBName String dtstestdata

目标实例中迁移对象所属数据库的名称。

ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

约束创建失败的错误提示。

ObjectDefinition String CREATE SEQUENCE "public"."collections_id_seq" MINVALUE 1 MAXVALUE 9223372036854775807 START 249 INCREMENT BY 1 ;

创建约束的结构语法定义。

ObjectName String customer

迁移对象名称。

ObjectType String Table

迁移对象的类型,固定为Table

SourceOwnerDBName String dtstestdata

源实例中迁移对象所属数据库的名称。

Status String Finished

约束创建状态,返回值:

  • NotStarted:未启动。
  • Migrating:创建中。
  • Failed:创建失败。
  • Finished:创建完成。
DestinationOwnerDBName String dtstestdata

目标实例中待迁移对象所属数据库的名称。

ErrorMessage String DTS-1020042 Execute sql error sql: DTS-1020042 Execute sql error sql: ERROR: column \"id\" named in key does not exist

结构迁移失败的错误提示。

ObjectDefinition String CREATE TABLE `dtstestdata`.`customer` (\n`runoob_id` int(10) unsigned auto_increment COMMENT '' NOT NULL , \n`runoob_title` varchar(100) CHARSET `utf8` COLLATE `utf8_general_ci` COMMENT '' NOT NULL , \n`runoob_author1216` varchar(40) CHARSET `utf8` COLLATE `utf8_general_ci` COMMENT '' NOT NULL , \n`submission_date1216` date COMMENT '' NULL \n, PRIMARY KEY (`runoob_id`)) engine=InnoDB AUTO_INCREMENT=200001 DEFAULT CHARSET=`utf8` DEFAULT COLLATE `utf8_general_ci` ROW_FORMAT= Dynamic comment = '' ;\n

迁移对象的结构语法定义。

ObjectName String customer

迁移对象名称。

ObjectType String Table

迁移对象类型,返回值:Table(表)、Constraint(约束)、Index(索引)、View(视图)、Materialize View(物化视图)、Type(自定义类型)、Synonym(同义词)、Trigger(触发器)、Function(函数)、Procedure(存储过程)、Package(包)、Default(默认值)、Rule(规则)、PlanGuide(执行计划)、Sequence(序列)。

SourceOwnerDBName String dtstestdata

源实例中待迁移对象所属数据库的名称。

Status String Finished

结构迁移状态,返回值:

  • NotStarted:未启动。
  • Migrating:迁移中。
  • Failed:迁移失败。
  • Finished:迁移完成。
Success String true

请求是否成功。

TotalRecordCount Long 1

总记录数。

示例

请求示例

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

正常返回示例

XML格式

<DescribeMigrationJobDetailResponse>
      <DataSynchronizationDetailList>
            <DataSynchronizationDetail>
                  <Status>Migrating</Status>
                  <TableName>customer</TableName>
                  <SourceOwnerDBName>dtstestdata</SourceOwnerDBName>
                  <DestinationOwnerDBName>dtstestdata</DestinationOwnerDBName>
            </DataSynchronizationDetail>
      </DataSynchronizationDetailList>
      <RequestId>0AE3CD0B-4148-426F-A90E-952467CC****</RequestId>
      <DataInitializationDetailList>
            <DataInitializationDetail>
                  <Status>Finished</Status>
                  <TableName>customer</TableName>
                  <TotalRowNum>201477</TotalRowNum>
                  <MigrationTime>0.0</MigrationTime>
                  <SourceOwnerDBName>dtstestdata</SourceOwnerDBName>
                  <DestinationOwnerDBName>dtstestdata</DestinationOwnerDBName>
                  <FinishRowNum>200001</FinishRowNum>
            </DataInitializationDetail>
      </DataInitializationDetailList>
      <Success>true</Success>
      <StructureInitializationDetailList>
            <StructureInitializationDetail>
                  <Status>Finished</Status>
                  <ObjectType>Table</ObjectType>
                  <ObjectDefinition>CREATE TABLE `dtstestdata`.`customer` (
`runoob_id`  int(10) unsigned   auto_increment  COMMENT ''   NOT NULL   , 
`runoob_title`  varchar(100)  CHARSET `utf8` COLLATE `utf8_general_ci`    COMMENT ''   NOT NULL   , 
`runoob_author1216`  varchar(40)  CHARSET `utf8` COLLATE `utf8_general_ci`    COMMENT ''   NOT NULL   , 
`submission_date1216`  date     COMMENT ''   NULL   
, PRIMARY KEY (`runoob_id`)) engine=InnoDB AUTO_INCREMENT=200001 DEFAULT CHARSET=`utf8` DEFAULT COLLATE `utf8_general_ci` ROW_FORMAT= Dynamic comment = '' ;
</ObjectDefinition>
                  <SourceOwnerDBName>dtstestdata</SourceOwnerDBName>
                  <DestinationOwnerDBName>dtstestdata</DestinationOwnerDBName>
                  <ObjectName>customer</ObjectName>
            </StructureInitializationDetail>
      </StructureInitializationDetailList>
</DescribeMigrationJobDetailResponse>

JSON格式

{
	"DataSynchronizationDetailList": {
		"DataSynchronizationDetail": [
			{
				"Status": "Migrating",
				"TableName": "customer",
				"SourceOwnerDBName": "dtstestdata",
				"DestinationOwnerDBName": "dtstestdata"
			}
		]
	},
	"RequestId": "0AE3CD0B-4148-426F-A90E-952467CC****",
	"DataInitializationDetailList": {
		"DataInitializationDetail": [
			{
				"Status": "Finished",
				"TableName": "customer",
				"TotalRowNum": "201477",
				"MigrationTime": "0.0",
				"SourceOwnerDBName": "dtstestdata",
				"DestinationOwnerDBName": "dtstestdata",
				"FinishRowNum": "200001"
			}
		]
	},
	"Success": true,
	"StructureInitializationDetailList": {
		"StructureInitializationDetail": [
			{
				"Status": "Finished",
				"ObjectType": "Table",
				"ObjectDefinition": "CREATE TABLE `dtstestdata`.`customer` (\n`runoob_id`  int(10) unsigned   auto_increment  COMMENT ''   NOT NULL   , \n`runoob_title`  varchar(100)  CHARSET `utf8` COLLATE `utf8_general_ci`    COMMENT ''   NOT NULL   , \n`runoob_author1216`  varchar(40)  CHARSET `utf8` COLLATE `utf8_general_ci`    COMMENT ''   NOT NULL   , \n`submission_date1216`  date     COMMENT ''   NULL   \n, PRIMARY KEY (`runoob_id`)) engine=InnoDB AUTO_INCREMENT=200001 DEFAULT CHARSET=`utf8` DEFAULT COLLATE `utf8_general_ci` ROW_FORMAT= Dynamic comment = '' ;\n",
				"SourceOwnerDBName": "dtstestdata",
				"DestinationOwnerDBName": "dtstestdata",
				"ObjectName": "customer"
			}
		]
	}
}

错误码

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