全部產品
Search
文件中心

Data Transmission Service:查詢一個遷移執行個體詳情

更新時間:Feb 08, 2025

調用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"
			}
		]
	}
}

錯誤碼

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