全部產品
Search
文件中心

Data Transmission Service:查詢一個遷移執行個體狀態

更新時間:Feb 08, 2025

調用DescribeMigrationJobStatus介面查詢一個資料移轉執行個體的狀態。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String DescribeMigrationJobStatus

系統規定參數,取值:DescribeMigrationJobStatus

MigrationJobId String dtsz2v12jfo309****

資料移轉執行個體ID,可以通過調用DescribeMigrationJobs介面查詢。

RegionId String cn-hangzhou

資料移轉執行個體所在地區的ID,詳情請參見支援的地區列表

ClientToken String 0c593ea1-3bea-11e9-b96b-88e9fe63****

保證請求等冪性。從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken只支援ASCII字元,且不能超過64個字元。

AccountId String 12323344****

阿里雲主帳號ID,無需設定,該參數即將下線。

返回資料

名稱 類型 樣本值 描述
DataInitializationStatus Struct

全量資料移轉執行狀態。

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

全量資料移轉失敗的錯誤提示。

Percent String 100

全量資料移轉進度,單位為百分比。

Progress String 200001

已完成全量資料初始化的記錄數。

Status String Finished

全量資料移轉狀態,取值包括:

  • NotStarted:未啟動。
  • Migrating:遷移中。
  • Failed:遷移失敗。
  • Finished:遷移完成。
DataSynchronizationStatus Struct

增量資料移轉執行狀態。

Checkpoint String 1612507847

遷移最新一條增量資料的時間戳記,格式為Unix時間戳記,單位為秒。

Delay String 0

增量資料移轉延遲,單位為秒。

ErrorMessage String 任務失敗太久無法恢複

增量資料移轉失敗的錯誤提示。

Percent String 95

增量資料移轉進度,單位為百分比。

Status String Catched

增量資料移轉狀態,取值包括:

  • NotStarted:未啟動。
  • Migrating:遷移中。
  • Failed:遷移失敗。
  • Finished:遷移完成。
  • Catched:無延遲。
DestinationEndpoint Struct

目標執行個體的串連資訊。

DatabaseName String dtstestdata

目標執行個體中待遷移對象所屬資料庫的名稱。

EngineName String MySQL

目標執行個體的資料庫類型。

IP String 172.16.88.***

目標執行個體的串連地址。

InstanceId String rm-bp1zc3iyqe3qw****

目標執行個體ID。

InstanceType String RDS

目標執行個體類型。

Port String 3306

目標執行個體的資料庫服務連接埠。

UserName String dtstest

目標執行個體的資料庫帳號。

oracleSID String testsid

Oracle資料庫的SID資訊。

說明 當目標執行個體的資料庫類型為Oracle時,才會返回該參數。
ErrCode String InternalError

調用出錯時返回的錯誤碼。

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

調用錯誤時返回的錯誤資訊。

MigrationJobClass String 2xlarge

資料移轉執行個體的規格,傳回值為:smallmediumlargexlarge2xlarge。更多規格說明,請參見資料移轉鏈路規格說明

MigrationJobId String dtsz2v12jfo309****

資料移轉執行個體ID。

MigrationJobName String MySQL遷移

資料移轉執行個體名稱。

MigrationJobStatus String Migrating

遷移執行個體狀態,傳回值:

  • NotStarted:未啟動。
  • Prechecking:預檢查中。
  • PrecheckFailed:預檢查失敗。
  • Migrating:遷移中。
  • Suspending:暫停中。
  • MigrationFailed:遷移失敗。
  • Finished:遷移完成。
MigrationMode Struct

遷移類型。

dataInitialization Boolean true

是否遷移全量資料,取值:

  • true:是。
  • false:否。
dataSynchronization Boolean true

是否遷移增量資料,取值:

  • true:是。
  • false:否。
structureInitialization Boolean true

是否執行結構遷移,取值:

  • true:是。
  • false:否。
MigrationObject String [{\"DBName\":\"dtstestdata\",\"TableIncludes\":[{\"TableName\":\"customer\"}]}]

遷移對象。

PayType String PostPaid

遷移執行個體的付費類型,傳回值固定為PostPaid(隨用隨付)。

PrecheckStatus Struct

預檢查情況。

Detail Array of CheckItem

各預檢查項的執行情況。

CheckItem
CheckStatus String Success

檢查結果,傳回值:

  • Success:通過該項檢查。
  • Failed:未通過該項檢查。
ErrorMessage String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

預檢查未通過的錯誤提示。

說明 CheckStatus參數傳回值為Failed時,才會返回本參數。
ItemName String CHECK_CONN_SRC

預檢查專案。

RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

預檢查未通過時對應的修複方法。

說明 CheckStatus參數傳回值為Failed時,才會返回本參數。
Percent String 100

預檢查整體進度,單位為百分比。

Status String Finished

預檢查狀態,傳回值:

  • NotStarted:未啟動。
  • Suspending:暫停中。
  • Checking:預檢查中。
  • Failed:預檢查失敗。
  • Finished:預檢查完成。
RequestId String A032E3B4-929B-48E9-97B9-37587CBF****

請求ID。

SourceEndpoint Struct

源執行個體的串連資訊。

DatabaseName String dtstestdatabase

源執行個體中待遷移對象所屬資料庫的名稱。

EngineName String MySQL

源執行個體的資料庫類型。

IP String 172.16.88.***

源執行個體的串連地址。

InstanceId String rm-bp1i99e8l7913****

源執行個體ID。

InstanceType String RDS

源執行個體類型。

  • RDS:阿里雲RDS執行個體。
  • ECS:ECS上的自建資料庫。
  • LocalInstance:有公網IP的自建資料庫。
  • Express:通過專線/VPN網關/智能網關接入的自建資料庫。
  • MongoDB:阿里雲MongoDB執行個體。
  • POLARDB:阿里雲PolarDB for MySQL叢集(該值僅適用於中國站)。
Port String 3306

源執行個體的資料庫服務連接埠。

UserName String dtstest

源執行個體的資料庫帳號。

oracleSID String dtstestdatabase

Oracle資料庫的SID資訊。

說明 當源執行個體的資料庫類型為Oracle時,才會返回該參數。
StructureInitializationStatus Struct

結構遷移執行狀態。

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

結構遷移失敗的錯誤提示。

Percent String 100

結構遷移進度,單位為百分比。

Progress String 1

已完成結構遷移的表的數量。

Status String Finished

結構遷移狀態,取值包括:

  • NotStarted:未啟動。
  • Migrating:遷移中。
  • Failed:遷移失敗。
  • Finished:遷移完成。
Success String true

請求是否成功。

TaskId String z2v12jfo309****

資料移轉任務ID,可用於配置控制台任務詳情頁面的連結。

說明 遷移任務詳情頁的連結為:https://dts.console.alibabacloud.com/#/progress/z2v12jfo309/config/ 。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=DescribeMigrationJobStatus
&MigrationJobId=dtsta7w132u12h****
&<公用請求參數>

正常返回樣本

XML格式

<DescribeMigrationJobStatusResponse>
      <TaskId>z2v12jfo309****</TaskId>
      <DataInitializationStatus>
            <Status>Finished</Status>
            <Progress>200001</Progress>
            <Percent>100</Percent>
      </DataInitializationStatus>
      <RequestId>A032E3B4-929B-48E9-97B9-37587CBF****</RequestId>
      <MigrationJobName>MySQL遷移</MigrationJobName>
      <PayType>PostPaid</PayType>
      <MigrationJobStatus>Migrating</MigrationJobStatus>
      <Success>true</Success>
      <MigrationMode>
            <structureInitialization>true</structureInitialization>
            <dataSynchronization>true</dataSynchronization>
            <dataInitialization>true</dataInitialization>
      </MigrationMode>
      <MigrationJobId>dtsz2v12jfo309****</MigrationJobId>
      <PrecheckStatus>
            <Status>Finished</Status>
            <Percent>100</Percent>
            <Detail>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_CONN_SRC</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_AUTH_SRC</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_CONN_DEST</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_AUTH_DEST</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_ON</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_MODE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_ROW_IMAGE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SERVER_ID</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_BINLOG_EXIST</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_ENGINE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_MYSQL_PASSOWRD_FORMAT</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SRC</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SQL_MODE</ItemName>
                  </CheckItem>
                  <CheckItem>
                        <CheckStatus>Success</CheckStatus>
                        <ItemName>CHECK_SAME_USER</ItemName>
                  </CheckItem>
            </Detail>
      </PrecheckStatus>
      <DestinationEndpoint>
            <UserName>dtstest</UserName>
            <InstanceId>rm-bp1zc3iyqe3qw****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
      </DestinationEndpoint>
      <MigrationJobClass>2xlarge</MigrationJobClass>
      <SourceEndpoint>
            <UserName>dtstest</UserName>
            <InstanceId>rm-bp1i99e8l7913****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
      </SourceEndpoint>
      <DataSynchronizationStatus>
            <Status>Catched</Status>
            <Checkpoint>1612507847</Checkpoint>
            <Percent>95</Percent>
            <Delay>0</Delay>
      </DataSynchronizationStatus>
      <StructureInitializationStatus>
            <Status>Finished</Status>
            <Progress>1</Progress>
            <Percent>100</Percent>
      </StructureInitializationStatus>
</DescribeMigrationJobStatusResponse>

JSON格式

{
	"TaskId": "z2v12jfo309****",
    "DataInitializationStatus": {
		"Status": "Finished",
		"Progress": "200001",
		"Percent": "100"
	},
	"RequestId": "A032E3B4-929B-48E9-97B9-37587CBF****",
	"MigrationJobName": "MySQL遷移",
	"PayType": "PostPaid",
	"MigrationJobStatus": "Migrating",
	"Success": true,
	"MigrationMode": {
		"structureInitialization": true,
		"dataSynchronization": true,
		"dataInitialization": true
	},
	"MigrationJobId": "dtsz2v12jfo309****",
	"PrecheckStatus": {
		"Status": "Finished",
		"Percent": "100",
		"Detail": {
			"CheckItem": [
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_CONN_SRC"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_AUTH_SRC"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_CONN_DEST"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_AUTH_DEST"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_BINLOG_ON"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_BINLOG_MODE"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_BINLOG_ROW_IMAGE"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_SERVER_ID"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_BINLOG_EXIST"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_ENGINE"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_MYSQL_PASSOWRD_FORMAT"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_SRC"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_SQL_MODE"
				},
				{
					"CheckStatus": "Success",
					"ItemName": "CHECK_SAME_USER"
				}
			]
		}
	},
	"DestinationEndpoint": {
		"UserName": "dtstest",
		"InstanceId": "rm-bp1zc3iyqe3qw****",
		"InstanceType": "RDS",
		"EngineName": "MySQL"
	},
	"MigrationJobClass": "2xlarge",
	"SourceEndpoint": {
		"UserName": "dtstest",
		"InstanceId": "rm-bp1i99e8l7913****",
		"InstanceType": "RDS",
		"EngineName": "MySQL"
	},
	"DataSynchronizationStatus": {
		"Status": "Catched",
		"Checkpoint": "1612507847",
		"Percent": "95",
		"Delay": "0"
	},
	"StructureInitializationStatus": {
		"Status": "Finished",
		"Progress": "1",
		"Percent": "100"
	}
}

錯誤碼

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