调用DescribeInitializationStatus查询同步初始化详情,即待同步对象的结构和存量数据初始化到目标库的情况。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeInitializationStatus |
系统规定参数,取值:DescribeInitializationStatus。 |
SynchronizationJobId | String | 是 | dtsi76118o3w92**** |
数据同步实例ID,可以通过调用DescribeSynchronizationJobs接口查询。 |
RegionId | String | 否 | cn-hangzhou |
数据同步实例所在地域的ID,详情请参见支持的地域列表。 |
PageSize | Integer | 否 | 30 |
每页记录数,取值:1~100,默认值为30。 |
PageNum | Integer | 否 | 1 |
页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1。 |
AccountId | String | 否 | 12323344**** |
阿里云主账号ID,无需设置,该参数即将下线。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DataInitializationDetails | Array of DataInitializationDetail |
全量数据初始化详情。 |
|
DestinationOwnerDBName | String | dtstestdata |
目标实例中待同步对象所属数据库的名称。 |
ErrorMessage | String | java.lang.NumberFormatException: For input string: "" |
全量数据初始化失败时返回对应的失败信息。 |
FinishRowNum | String | 9993 |
已完成同步的行数。 说明 该参数表示实际同步的总行数,而参数TotalRowNum的值来源于同步开始前源库的系统表,由于同步时间差,会导致两者的值会有出入。
|
SourceOwnerDBName | String | dtstestdata |
源实例中待同步对象所属数据库的名称。 |
Status | String | Finished |
全量数据初始化的状态,返回值:
|
TableName | String | customer |
同步对象的表名。 |
TotalRowNum | String | 9981 |
需同步的总行数。 说明 该参数的值来源于同步开始前源库的系统表,而参数FinishRowNum表示实际同步的总行数,由于同步时间差,会导致两者的值会有出入。
|
UsedTime | String | 0.0 |
全量同步初始化的耗时。 |
DataSynchronizationDetails | Array of DataSynchronizationDetail |
增量数据同步详情。 说明 该参数合集及包含的返回参数即将下线。
|
|
DestinationOwnerDBName | String | dtstestdata |
目标实例中待同步对象所属数据库的名称。 |
ErrorMessage | String | 任务失败太久无法恢复 |
增量数据同步失败时返回对应的失败信息。 |
SourceOwnerDBName | String | dtstestdata |
源实例中待同步对象所属数据库的名称。 |
Status | String | Migrating |
增量数据同步的状态,返回值:
|
TableName | String | customer |
同步对象的表名。 |
ErrCode | String | InternalError |
调用出错时返回的错误码。 |
ErrMessage | String | The request processing has failed due to some unknown error. |
调用错误时返回对应的错误信息。 |
RequestId | String | 150DECD9-13FF-4929-A5DE-855BE9CC**** |
请求ID。 |
StructureInitializationDetails | Array of StructureInitializationDetail |
结构初始化详情。 |
|
Constraints | Array of StructureInitializationDetail |
同步对象对应的约束(例如索引、外键等)。 说明 只有ObjectType为Table,且同步对象有约束,才会返回本参数。
|
|
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 |
约束创建状态,返回值:
|
DestinationOwnerDBName | String | dtstestdata |
目标实例中待同步对象所属数据库的名称。 |
ErrorMessage | String | DTS-1020042 Execute sql error sql: Table 'customer' already exists |
结构初始化失败时返回对应的失败信息。 |
ObjectDefinition | String | CREATE TABLE `dtstestdata`.`customer` (\n`customer_id` int(10) unsigned auto_increment COMMENT '' NOT NULL , \n`customer_title` varchar(100) CHARSET `utf8` COLLATE `utf8_general_ci` COMMENT '' NOT NULL , \n`customer_company1216` varchar(40) CHARSET `utf8` COLLATE `utf8_general_ci` COMMENT '' NOT NULL , \n`submission_date1216` date COMMENT '' NULL \n, PRIMARY KEY (`customer_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 |
结构初始化的状态。返回值:
|
Success | String | true |
请求是否成功。 |
示例
请求示例
http(s)://dts.aliyuncs.com/?Action=DescribeInitializationStatus
&SynchronizationJobId=dtsi76118o3w92****
&<公共请求参数>
正常返回示例
XML
格式
<DescribeInitializationStatusResponse>
<StructureInitializationDetails>
<Status>Finished</Status>
<ObjectType>Table</ObjectType>
<ObjectDefinition>CREATE TABLE `dtstestdata`.`customer` (
`customer_id` int(10) unsigned auto_increment COMMENT '' NOT NULL ,
`customer_title` varchar(100) CHARSET `utf8` COLLATE `utf8_general_ci` COMMENT '' NOT NULL ,
`customer_author1216` varchar(40) CHARSET `utf8` COLLATE `utf8_general_ci` COMMENT '' NOT NULL ,
`submission_date1216` date COMMENT '' NULL
, PRIMARY KEY (`customer_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>
</StructureInitializationDetails>
<RequestId>150DECD9-13FF-4929-A5DE-855BE9CC****</RequestId>
<DataInitializationDetails>
<Status>Finished</Status>
<TableName>customer</TableName>
<TotalRowNum>9981</TotalRowNum>
<UsedTime>0.0</UsedTime>
<SourceOwnerDBName>dtstestdata</SourceOwnerDBName>
<DestinationOwnerDBName>dtstestdata</DestinationOwnerDBName>
<FinishRowNum>9993</FinishRowNum>
</DataInitializationDetails>
<Success>true</Success>
</DescribeInitializationStatusResponse>
JSON
格式
{
"StructureInitializationDetails": [
{
"Status": "Finished",
"ObjectType": "Table",
"ObjectDefinition": "CREATE TABLE `dtstestdata`.`customer` (\n`customer_id` int(10) unsigned auto_increment COMMENT '' NOT NULL , \n`customer_title` varchar(100) CHARSET `utf8` COLLATE `utf8_general_ci` COMMENT '' NOT NULL , \n`customer_author1216` varchar(40) CHARSET `utf8` COLLATE `utf8_general_ci` COMMENT '' NOT NULL , \n`submission_date1216` date COMMENT '' NULL \n, PRIMARY KEY (`customer_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"
}
],
"RequestId": "150DECD9-13FF-4929-A5DE-855BE9CC****",
"DataInitializationDetails": [
{
"Status": "Finished",
"TableName": "customer",
"TotalRowNum": "9981",
"UsedTime": "0.0",
"SourceOwnerDBName": "dtstestdata",
"DestinationOwnerDBName": "dtstestdata",
"FinishRowNum": "9993"
}
],
"Success": true
}
错误码
访问错误中心查看更多错误码。