全部產品
Search
文件中心

Data Transmission Service:查詢一個或多個同步執行個體狀態

更新時間:Feb 08, 2025

調用DescribeSynchronizationJobStatusList查詢一個或多個資料同步執行個體同步狀態。

調試

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

請求參數

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

系統規定參數,取值:DescribeSynchronizationJobStatusList

SynchronizationJobIdListJsonStr String ["dtsexjk1alb116****","dtskfq1149w254****"]

資料同步執行個體ID,格式為JSON數組,可以通過調用DescribeSynchronizationJobs介面查詢。

RegionId String cn-hangzhou

地區ID,傳入本參數來指定執行個體所在地區,詳情請參見支援的地區列表

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

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

AccountId String 12323344****

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

返回資料

名稱 類型 樣本值 描述
ErrCode String InternalError

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

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

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

PageNumber Integer 1

頁碼。

PageRecordCount Integer 2

一頁展示的同步執行個體數量。

RequestId String 1413460B-138A-48D1-836C-B24EDDC1****

請求ID。

Success String true

請求是否成功。

SynchronizationJobListStatusList Array of SynchronizationJobStatusInfo

同步任務狀態列表。

SynchronizationDirectionInfoList Array of SynchronizationDirectionInfo

同步方向詳情列表。

Checkpoint String 1610524452

同步最新一條資料的時間戳記,格式為Unix時間戳記。

說明 Unix時間戳記轉換工具可用搜尋引擎擷取。
Status String InitializeFailed

同步執行個體在該方向上的同步狀態,傳回值:

  • NotStarted:未啟動
  • Prechecking:預檢查中
  • PrecheckFailed:預檢查失敗
  • Initializing:同步初始化
  • InitializeFailed:同步初始化失敗
  • Synchronizing:同步中
  • Failed:同步失敗
  • Suspending:暫停
  • Modifying:同步對象變更中
  • Finished:完成
SynchronizationDirection String Forward

同步方向,傳回值:

  • Forward:正向。
  • Reverse:反向。
SynchronizationJobId String dtsexjk1alb116****

資料同步執行個體ID。

TotalRecordCount Long 2

所查詢的同步執行個體總數。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationJobStatusList
&SynchronizationJobIdListJsonStr=["dtsexjk1alb116****","dtskfq1149w254****"]
&<公用請求參數>

正常返回樣本

XML格式

<TotalRecordCount>2</TotalRecordCount>
<PageRecordCount>2</PageRecordCount>
<RequestId>1413460B-138A-48D1-836C-B24EDDC1****</RequestId>
<PageNumber>1</PageNumber>
<SynchronizationJobListStatusList>
    <SynchronizationJobId>dtsexjk1alb116****</SynchronizationJobId>
    <SynchronizationDirectionInfoList>
        <Status>InitializeFailed</Status>
        <SynchronizationDirection>Forward</SynchronizationDirection>
    </SynchronizationDirectionInfoList>
</SynchronizationJobListStatusList>
<SynchronizationJobListStatusList>
    <SynchronizationJobId>dtskfq1149w254****</SynchronizationJobId>
    <SynchronizationDirectionInfoList>
        <Status>Failed</Status>
        <Checkpoint>1610524457</Checkpoint>
        <SynchronizationDirection>Forward</SynchronizationDirection>
    </SynchronizationDirectionInfoList>
</SynchronizationJobListStatusList>
<Success>true</Success>

JSON格式

{
	"TotalRecordCount": 2,
	"PageRecordCount": 2,
	"RequestId": "1413460B-138A-48D1-836C-B24EDDC1****",
	"PageNumber": 1,
	"SynchronizationJobListStatusList": [
		{
			"SynchronizationJobId": "dtsexjk1alb116****",
			"SynchronizationDirectionInfoList": [
				{
					"Status": "InitializeFailed",
					"SynchronizationDirection": "Forward"
				}
			]
		},
		{
			"SynchronizationJobId": "dtskfq1149w254****",
			"SynchronizationDirectionInfoList": [
				{
					"Status": "Failed",
					"Checkpoint": "1610524457",
					"SynchronizationDirection": "Forward"
				}
			]
		}
	],
	"Success": true
}

錯誤碼

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