Queries the details of initial data synchronization, including the information about the schemas and historical data of the object to be synchronized.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInitializationStatus

The operation that you want to perform. Set the value to DescribeInitializationStatus.

SynchronizationJobId String Yes dtsi76118o3w92****

The ID of the data synchronization instance. You can call the DescribeSynchronizationJobs operation to query the instance ID.

RegionId String No cn-hangzhou

The ID of the region where the data synchronization instance resides. For more information, see List of supported regions.

PageSize Integer No 30

The number of entries to return on each page. Valid values: 1 to 100. Default value: 30.

PageNum Integer No 1

The number of the page to return. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: 1.

AccountId String No 12323344****

The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter will be removed in the future.

Response parameters

Parameter Type Example Description
DataInitializationDetails Array of DataInitializationDetail

The details of initial full data synchronization.

DestinationOwnerDBName String dtstestdata

The name of the database to which the object in the destination instance belongs.

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

The error message returned if initial full data synchronization failed.

FinishRowNum String 9993

The total number of rows that are actually synchronized.

Note This parameter indicates the total number of actually synchronized rows. In contrast, the value of the TotalRowNum parameter is calculated based on the system tables in the source database. The values of the two parameters may be different due to time difference.
SourceOwnerDBName String dtstestdata

The name of the database to which the object in the source instance belongs.

Status String Finished

The status of initial full data synchronization. Valid values:

  • NotStarted
  • Migrating
  • Failed
  • Finished
TableName String customer

The table name.

TotalRowNum String 9981

The total number of rows that are supposed to be synchronized.

Note The value of this parameter is calculated based on the system tables in the source database. In contrast, the FinishRowNum parameter indicates the total number of actually synchronized rows. The values of the two parameters may be different due to time difference.
UsedTime String 0.0

The time spent on full data synchronization.

DataSynchronizationDetails Array of DataSynchronizationDetail

The details of incremental data synchronization.

Note This parameter and the parameters it contains will be removed in the future.
DestinationOwnerDBName String dtstestdata

The name of the database to which the object in the destination instance belongs.

ErrorMessage String The task has failed for a long time and cannot be recovered.

The error message returned if incremental data synchronization failed.

SourceOwnerDBName String dtstestdata

The name of the database to which the object in the source instance belongs.

Status String Migrating

The status of incremental data synchronization. Valid values:

  • NotStarted
  • Migrating
  • Failed
  • Finished
TableName String customer

The table name.

ErrCode String InternalError

The error code returned if the call failed.

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

The error message returned if the call failed.

RequestId String 150DECD9-13FF-4929-A5DE-855BE9CC****

The ID of the request.

StructureInitializationDetails Array of StructureInitializationDetail

The details of initial schema synchronization.

Constraints Array of StructureInitializationDetail

The constraints of the synchronization object, such as indexes and foreign keys.

Note This parameter is returned only if the ObjectType parameter is set to Table and the synchronization object has constraints.
DestinationOwnerDBName String dtstestdata

The name of the database to which the object in the destination instance belongs.

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

The error message returned if constraints failed to be created.

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

The syntax to create constraints.

ObjectName String customer

The name of the object.

ObjectType String Table

The type of the object. The value is Table.

SourceOwnerDBName String dtstestdata

The name of the database to which the object in the source instance belongs.

Status String Finished

The status of constraint creation. Valid values:

  • NotStarted
  • Migrating
  • Failed
  • Finished
DestinationOwnerDBName String dtstestdata

The name of the database to which the object in the destination instance belongs.

ErrorMessage String DTS-1020042 Execute sql error sql: Table 'customer' already exists

The error message returned if initial schema synchronization failed.

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

The schema of the object.

ObjectName String customer

The name of the object.

ObjectType String Table

The type of the object. Valid values:

Table, Constraint, Index, View, Materialize View, Type, Synonym, Trigger, Function, Procedure, Package, Default, Rule, PlanGuide, and Sequence.

SourceOwnerDBName String dtstestdata

The name of the database to which the object in the source instance belongs.

Status String Finished

The status of initial schema synchronization. Valid values:

  • NotStarted
  • Migrating
  • Failed
  • Finished
Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeInitializationStatus
&SynchronizationJobId=dtsi76118o3w92****
&<Common request parameters>

Sample responses

XML format

<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 format

{
    "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
}
     

Error codes

For a list of error codes, visit the API Error Center.