調用DescribeMigrationJobStatus接口查詢一個數(shù)據(jù)遷移實例的狀態(tài)。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeMigrationJobStatus

系統(tǒng)規(guī)定參數(shù)，取值：DescribeMigrationJobStatus。

MigrationJobId String 是 dtsz2v12jfo309****

數(shù)據(jù)遷移實例ID，可以通過調用DescribeMigrationJobs接口查詢。

RegionId String 否 cn-hangzhou

數(shù)據(jù)遷移實例所在地域的ID，詳情請參見支持的地域列表。

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

保證請求冪等性。從您的客戶端生成一個參數(shù)值，確保不同請求間該參數(shù)值唯一。ClientToken只支持ASCII字符，且不能超過64個字符。

AccountId String 否 12323344****

阿里云主賬號ID，無需設置，該參數(shù)即將下線。

返回數(shù)據(jù)

名稱 類型 示例值 描述
DataInitializationStatus Struct

全量數(shù)據(jù)遷移執(zhí)行狀態(tài)。
ErrorMessage String java.lang.NumberFormatException: For input string: ""

全量數(shù)據(jù)遷移失敗的錯誤提示。
Percent String 100

全量數(shù)據(jù)遷移進度，單位為百分比。
Progress String 200001

已完成全量數(shù)據(jù)初始化的記錄數(shù)。
Status String Finished

全量數(shù)據(jù)遷移狀態(tài)，取值包括：

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

增量數(shù)據(jù)遷移執(zhí)行狀態(tài)。
Checkpoint String 1612507847

遷移最新一條增量數(shù)據(jù)的時間戳，格式為Unix時間戳，單位為秒。
Delay String 0

增量數(shù)據(jù)遷移延遲，單位為秒。
ErrorMessage String 任務失敗太久無法恢復

增量數(shù)據(jù)遷移失敗的錯誤提示。
Percent String 95

增量數(shù)據(jù)遷移進度，單位為百分比。
Status String Catched

增量數(shù)據(jù)遷移狀態(tài)，取值包括：

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

目標實例的連接信息。
DatabaseName String dtstestdata

目標實例中待遷移對象所屬數(shù)據(jù)庫的名稱。
EngineName String MySQL

目標實例的數(shù)據(jù)庫類型。
IP String 172.16.88.***

目標實例的連接地址。
InstanceId String rm-bp1zc3iyqe3qw****

目標實例ID。
InstanceType String RDS

目標實例類型。
Port String 3306

目標實例的數(shù)據(jù)庫服務端口。
UserName String dtstest

目標實例的數(shù)據(jù)庫賬號。
oracleSID String testsid

Oracle數(shù)據(jù)庫的SID信息。

說明 當目標實例的數(shù)據(jù)庫類型為Oracle時，才會返回該參數(shù)。
ErrCode String InternalError

調用出錯時返回的錯誤碼。
ErrMessage String The request processing has failed due to some unknown error.

調用錯誤時返回的錯誤信息。
MigrationJobClass String 2xlarge

數(shù)據(jù)遷移實例的規(guī)格，返回值為：small、medium、large、xlarge或2xlarge。更多規(guī)格說明，請參見數(shù)據(jù)遷移鏈路規(guī)格說明。

MigrationJobId String dtsz2v12jfo309****

數(shù)據(jù)遷移實例ID。
MigrationJobName String MySQL遷移

數(shù)據(jù)遷移實例名稱。
MigrationJobStatus String Migrating

遷移實例狀態(tài)，返回值：

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

遷移類型。
dataInitialization Boolean true

是否遷移全量數(shù)據(jù)，取值：

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

是否遷移增量數(shù)據(jù)，取值：

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

是否執(zhí)行結構遷移，取值：

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

遷移對象。
PayType String PostPaid

遷移實例的付費類型，返回值固定為PostPaid（按量付費）。

PrecheckStatus Struct

預檢查情況。
Detail Array of CheckItem

各預檢查項的執(zhí)行情況。
CheckItem
CheckStatus String Success

檢查結果，返回值：

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

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

說明 當CheckStatus參數(shù)返回值為Failed時，才會返回本參數(shù)。
ItemName String CHECK_CONN_SRC

預檢查項目。
RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

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

說明 當CheckStatus參數(shù)返回值為Failed時，才會返回本參數(shù)。
Percent String 100

預檢查整體進度，單位為百分比。
Status String Finished

預檢查狀態(tài)，返回值：

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

請求ID。
SourceEndpoint Struct

源實例的連接信息。
DatabaseName String dtstestdatabase

源實例中待遷移對象所屬數(shù)據(jù)庫的名稱。
EngineName String MySQL

源實例的數(shù)據(jù)庫類型。
IP String 172.16.88.***

源實例的連接地址。
InstanceId String rm-bp1i99e8l7913****

源實例ID。
InstanceType String RDS

源實例類型。

  • RDS：阿里云RDS實例。
  • ECS：ECS上的自建數(shù)據(jù)庫。
  • LocalInstance：有公網IP的自建數(shù)據(jù)庫。
  • Express：通過專線/VPN網關/智能網關接入的自建數(shù)據(jù)庫。
  • MongoDB：阿里云MongoDB實例。
  • POLARDB：阿里云PolarDB for MySQL集群（該值僅適用于中國站）。
Port String 3306

源實例的數(shù)據(jù)庫服務端口。
UserName String dtstest

源實例的數(shù)據(jù)庫賬號。
oracleSID String dtstestdatabase

Oracle數(shù)據(jù)庫的SID信息。

說明 當源實例的數(shù)據(jù)庫類型為Oracle時，才會返回該參數(shù)。
StructureInitializationStatus Struct

結構遷移執(zhí)行狀態(tài)。
ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

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

結構遷移進度，單位為百分比。
Progress String 1

已完成結構遷移的表的數(shù)量。
Status String Finished

結構遷移狀態(tài)，取值包括：

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

請求是否成功。
TaskId String z2v12jfo309****

數(shù)據(jù)遷移任務ID，可用于配置控制臺任務詳情頁面的鏈接。

說明 遷移任務詳情頁的鏈接為：https://dts.console.aliyun.com/#/progress/z2v12jfo309/config/ 。

示例

請求示例

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

正常返回示例

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

錯誤碼

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