调用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 synchronizing

同步实例在该方向上的同步状态,返回值:

  • 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格式

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

JSON格式

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

错误码

访问错误中心查看更多错误码。