調(diào)用DescribeSynchronizationJobStatus查詢一個同步實例的運行狀態(tài)。

調(diào)試

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

請求參數(shù)

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

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

SynchronizationJobId String 是 dtsexjk1alb116****

數(shù)據(jù)同步實例ID，可以通過調(diào)用DescribeSynchronizationJobs接口查詢。

RegionId String 否 cn-hangzhou

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

SynchronizationDirection String 否 Forward

同步方向，取值：

  • Forward：正向。
  • Reverse：反向。
說明 默認取值為Forward。

只有當(dāng)數(shù)據(jù)同步實例的同步拓撲為雙向同步時，本參數(shù)傳入Reverse才會生效。

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

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

AccountId String 否 12323344****

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

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

名稱 類型 示例值 描述
Checkpoint String 1610616144

同步最新一條數(shù)據(jù)的時間戳，格式為Unix時間戳。

說明 Unix時間戳轉(zhuǎn)換工具可用搜索引擎獲取。
DataInitialization String true

是否執(zhí)行全量數(shù)據(jù)初始化，取值：

  • true：是。
  • false：否。
DataInitializationStatus Struct

全量數(shù)據(jù)初始化狀態(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ù)同步狀態(tài)。
Checkpoint String 1610709865

同步最新一條數(shù)據(jù)的時間戳，格式為Unix時間戳。
Delay String 0

增量數(shù)據(jù)同步延遲，單位為秒。
DelayMillis Long 856

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

增量數(shù)據(jù)同步失敗的錯誤提示。
Percent String 100

增量數(shù)據(jù)同步進度，單位為百分比。
Status String Finished

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

  • NotStarted：未啟動。
  • Migrating：同步中。
  • Failed：同步失敗。
  • Finished：同步完成。
Delay String 0

同步延遲，單位為秒。
DelayMillis Long 506

同步延遲，單位為毫秒。
DestinationEndpoint Struct

目標(biāo)實例的連接信息。
EngineName String MySQL

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

目標(biāo)實例的連接地址。
InstanceId String rm-bp162d4tp0500****

目標(biāo)實例ID。
InstanceType String RDS

目標(biāo)實例類型。
Port String 3306

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

目標(biāo)實例的數(shù)據(jù)庫賬號。
ErrCode String InternalError

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

調(diào)用錯誤時返回的錯誤信息。
ErrorMessage String DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\n\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].

數(shù)據(jù)同步失敗的錯誤提示。
ExpireTime String 2021-03-07T16:00:00Z

同步實例的到期時間，yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

說明 當(dāng)PayType參數(shù)的返回值為PrePaid時才會返回本參數(shù)。
PayType String PrePaid

同步實例的付費類型，返回值：

  • PrePaid：包年包月（預(yù)付費）。
  • PostPaid：按量付費（后付費）。
Performance Struct

同步鏈路概況信息。
FLOW String 1

每秒同步數(shù)據(jù)的流量，單位為MB/s。
RPS String 100

每秒同步SQL語句的次數(shù)，包括BEGIN、COMMIT 、DML語句（INSERT、DELETE、UPDATE）及DDL語句。
PrecheckStatus Struct

預(yù)檢查狀態(tài)。
Detail Array of CheckItem

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

檢查結(jié)果，返回值：

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

預(yù)檢查未通過的錯誤提示。

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

預(yù)檢查項目。
RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

預(yù)檢查未通過時對應(yīng)的修復(fù)方法。

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

預(yù)檢查整體進度，單位為百分比。
Status String Success

預(yù)檢查結(jié)果，返回值：

  • Success：通過該項檢查。
  • Failed：未通過該項檢查。
RequestId String DACDF659-AFC6-4DC8-ADB8-4569419A4****

請求ID。
SourceEndpoint Struct

源實例連接信息。
EngineName String MySQL

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

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

源實例ID。
InstanceType String RDS

源實例類型。
Port String 3306

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

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

同步實例的狀態(tài)，返回值：

  • notStarted：未啟動。
  • prechecking：預(yù)檢查中。
  • precheckFailed：預(yù)檢查失敗。
  • initializating：同步初始化中。
  • initializeFailed：同步初始化失敗。
  • synchronizing：同步中。
  • failed：同步失敗。
  • suspending：暫停。
  • modifying：同步對象變更中。
  • finished：完成。
StructureInitialization String true

是否執(zhí)行結(jié)構(gòu)初始化，返回值：

  • true：是
  • false：否
StructureInitializationStatus Struct

結(jié)構(gòu)初始化狀態(tài)。
ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

結(jié)構(gòu)初始化出現(xiàn)異常的錯誤提示。
Percent String 100

結(jié)構(gòu)初始化進度，單位為百分比。
Progress String 1

已完成結(jié)構(gòu)初始化的表的數(shù)量。
Status String Finished

結(jié)構(gòu)初始化狀態(tài)，取值包括：

  • NotStarted：未啟動。
  • Migrating：初始化中。
  • Failed：初始化失敗。
  • Finished：初始化完成。
Success String true

請求是否成功。
SynchronizationDirection String Forward

同步方向，返回值：

  • Forward：正向。
  • Reverse：反向。
SynchronizationJobClass String large

同步鏈路規(guī)格。
SynchronizationJobName String MySQL同步

同步實例名稱。
SynchronizationJobId String dtsexjk1alb116****

數(shù)據(jù)同步實例ID。
SynchronizationObjects Array of SynchronizationObject

同步對象。
NewSchemaName String newdtstestdatabase

待同步的庫在目標(biāo)數(shù)據(jù)庫中映射的名稱。
SchemaName String dtstestdatabase

待同步的庫名。
TableExcludes Array of TableExclude

待同步庫中排除的表，這些表將不會被同步。
TableName String order

排除的表的名稱。
TableIncludes Array of TableInclude

待同步的表。
TableName String customer

待同步表名。
TaskId String exjk1alb116****

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

說明 同步任務(wù)詳情頁的鏈接為：https://dts.console.aliyun.com/#/syncmore/exjk1alb116/config/ 。

示例

請求示例

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

正常返回示例

XML格式 

<DescribeSynchronizationJobStatusResponse>
      <TaskId>exjk1alb116****</TaskId>
      <SynchronizationObjects>
            <SchemaName>newdtstestdatabase</SchemaName>
            <NewSchemaName>dtstestdatabase</NewSchemaName>
      </SynchronizationObjects>
      <DataInitializationStatus>
            <Status>Finished</Status>
            <Progress>200001</Progress>
            <Percent>100</Percent>
      </DataInitializationStatus>
      <Delay>0</Delay>
      <Success>true</Success>
      <DelayMillis>0</DelayMillis>
      <DataInitialization>true</DataInitialization>
      <SynchronizationJobClass>large</SynchronizationJobClass>
      <Status>synchronizing</Status>
      <RequestId>DACDF659-AFC6-4DC8-ADB8-4569419A****</RequestId>
      <SynchronizationJobName>MySQL同步</SynchronizationJobName>
      <PayType>PostPaid</PayType>
      <ErrMessage></ErrMessage>
      <PrecheckStatus>
            <Status>Finished</Status>
            <Percent>100</Percent>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_CONN_SRC</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_AUTH_SRC</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_CONN_DEST</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_AUTH_DEST</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_BINLOG_ON</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_BINLOG_MODE</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_BINLOG_ROW_IMAGE</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_SERVER_ID</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_BINLOG_EXIST</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_ENGINE</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_MYSQL_PASSOWRD_FORMAT</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_SRC</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_SAME_OBJ</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_SQL_MODE</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_SAME_USER</ItemName>
            </Detail>
            <Detail>
                  <CheckStatus>Success</CheckStatus>
                  <ItemName>CHECK_TOPOLOGY</ItemName>
            </Detail>
      </PrecheckStatus>
      <Checkpoint>1610616144</Checkpoint>
      <SynchronizationJobId>dtsexjk1alb116****</SynchronizationJobId>
      <DestinationEndpoint>
            <InstanceId>rm-bp1u40w1ip917****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
      </DestinationEndpoint>
      <SourceEndpoint>
            <InstanceId>rm-bp1i99e8l7913****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
      </SourceEndpoint>
      <StructureInitialization>true</StructureInitialization>
      <Performance>
            <RPS>0</RPS>
            <FLOW>0.00MB/s</FLOW>
      </Performance>
      <StructureInitializationStatus>
            <Status>Finished</Status>
            <Progress>1</Progress>
            <Percent>100</Percent>
      </StructureInitializationStatus>
</DescribeSynchronizationJobStatusResponse>

JSON格式 

{
	"TaskId": "exjk1alb116****",
    "SynchronizationObjects": [
		{
			"TableIncludes": [],
			"TableExcludes": [],
			"SchemaName": "newdtstestdatabase",
			"NewSchemaName": "dtstestdatabase"
		}
	],
	"DataInitializationStatus": {
		"Status": "Finished",
		"Progress": "200001",
		"Percent": "100"
	},
	"Delay": "0",
	"Success": true,
	"DelayMillis": 0,
	"DataInitialization": true,
	"SynchronizationJobClass": "large",
	"Status": "synchronizing",
	"RequestId": "DACDF659-AFC6-4DC8-ADB8-4569419A****",
	"SynchronizationJobName": "MySQL同步",
	"PayType": "PostPaid",
	"ErrMessage": "",
	"PrecheckStatus": {
		"Status": "Finished",
		"Percent": "100",
		"Detail": [
			{
				"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_SAME_OBJ"
			},
			{
				"CheckStatus": "Success",
				"ItemName": "CHECK_SQL_MODE"
			},
			{
				"CheckStatus": "Success",
				"ItemName": "CHECK_SAME_USER"
			},
			{
				"CheckStatus": "Success",
				"ItemName": "CHECK_TOPOLOGY"
			}
		]
	},
	"Checkpoint": "1610616144",
	"SynchronizationJobId": "dtsexjk1alb116****",
	"DestinationEndpoint": {
		"InstanceId": "rm-bp1u40w1ip917****",
		"InstanceType": "RDS",
		"EngineName": "MySQL"
	},
	"SourceEndpoint": {
		"InstanceId": "rm-bp1i99e8l7913****",
		"InstanceType": "RDS",
		"EngineName": "MySQL"
	},
	"StructureInitialization": true,
	"Performance": {
		"RPS": "0",
		"FLOW": "0.00MB/s"
	},
	"StructureInitializationStatus": {
		"Status": "Finished",
		"Progress": "1",
		"Percent": "100"
	}
}

錯誤碼

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