調用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

全量數據初始化的狀態,返回值:

  • NotStarted:未啟動。
  • Migrating:初始化中。
  • Failed:初始化失敗。
  • 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

增量數據同步的狀態,返回值:

  • NotStarted:未啟動。
  • Migrating:同步中。
  • Failed:同步失敗。
  • Finished:同步完成。
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

同步對象對應的約束(例如索引、外鍵等)。

說明 只有ObjectTypeTable,且同步對象有約束,才會返回本參數。
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: 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

結構初始化的狀態。返回值:

  • NotStarted:未啟動。
  • Migrating:初始化中。
  • Failed:初始化失敗。
  • 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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。