调用DescribeSynchronizationJobStatus查询一个同步实例的运行状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSynchronizationJobStatus

系统规定参数,取值:DescribeSynchronizationJobStatus

SynchronizationJobId String dtsexjk1alb116****

数据同步实例ID,可以通过调用DescribeSynchronizationJobs接口查询。

RegionId String cn-hangzhou

数据同步实例所在地域的ID,详情请参见支持的地域列表

SynchronizationDirection String Forward

同步方向,取值:

  • Forward:正向。
  • Reverse:反向。
说明 默认取值为Forward

只有当数据同步实例的同步拓扑为双向同步时,本参数传入Reverse才会生效。

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

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

AccountId String 12323344****

阿里云主账号ID,无需设置,该参数即将下线。

返回数据

名称 类型 示例值 描述
Checkpoint String 1610616144

同步最新一条数据的时间戳,格式为Unix时间戳。

说明 Unix时间戳转换工具可用搜索引擎获取。
DataInitialization String true

是否执行全量数据初始化,取值:

  • true:是。
  • false:否。
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 1610709865

同步最新一条数据的时间戳,格式为Unix时间戳。

Delay String 0

增量数据同步延迟,单位为秒。

DelayMillis Long 856

增量数据同步延迟,单位为毫秒。

ErrorMessage String 任务失败太久 无法恢复

增量数据同步失败的错误提示。

Percent String 100

增量数据同步进度,单位为百分比。

Status String Finished

增量数据同步状态,取值包括:

  • NotStarted:未启动。
  • Migrating :同步中。
  • Failed :同步失败。
  • Finished:同步完成。
Delay String 0

同步延迟,单位为秒。

DelayMillis Long 506

同步延迟,单位为毫秒。

DestinationEndpoint Struct

目标实例的连接信息。

EngineName String MySQL

目标实例的数据库类型。

IP String 172.16.88.***

目标实例的连接地址。

InstanceId String rm-bp162d4tp0500****

目标实例ID。

InstanceType String RDS

目标实例类型。

Port String 3306

目标实例的数据库服务端口。

UserName String dtstest

目标实例的数据库账号。

ErrCode String InternalError

调用出错时返回的错误码。

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

调用错误时返回的错误信息。

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].

数据同步失败的错误提示。

ExpireTime String 2021-03-07T16:00:00Z

同步实例的到期时间,yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明PayType参数的返回值为PrePaid时才会返回本参数。
PayType String PrePaid

同步实例的付费类型,返回值:

  • PrePaid:包年包月(预付费)。
  • PostPaid:按量付费(后付费)。
Performance Struct

同步链路概况信息。

FLOW String 1

每秒同步数据的流量,单位为MB/s。

RPS String 100

每秒同步SQL语句的次数,包括BEGIN、COMMIT 、DML语句(INSERT、DELETE、UPDATE)及DDL语句。

PrecheckStatus Struct

预检查状态。

Detail Array of 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 Success

预检查结果,返回值:

  • Success:通过该项检查。
  • Failed:未通过该项检查。
RequestId String DACDF659-AFC6-4DC8-ADB8-4569419A4****

请求ID。

SourceEndpoint Struct

源实例连接信息。

EngineName String MySQL

源实例的数据库类型。

IP String 172.16.88.***

源实例的连接地址。

InstanceId String rm-bp1i99e8l7913****

源实例ID。

InstanceType String RDS

源实例类型。

Port String 3306

源实例的数据库服务端口。

UserName String dtstest

源实例的数据库账号。

Status String Synchronizing

同步实例的状态,返回值:

  • NotStarted:未启动。
  • Prechecking:预检查中。
  • PrecheckFailed:预检查失败。
  • Initializating:同步初始化中。
  • InitializeFailed:同步初始化失败。
  • Synchronizing:同步中。
  • Failed:同步失败。
  • Suspending:暂停。
  • Modifying:同步对象变更中。
  • Finished:完成。
StructureInitialization String true

是否执行结构初始化,返回值:

  • true:是
  • false:否
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

请求是否成功。

SynchronizationDirection String Forward

同步方向,返回值:

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

同步链路规格。

SynchronizationJobName String MySQL同步

同步实例名称。

SynchronizationJobId String dtsexjk1alb116****

数据同步实例ID。

SynchronizationObjects Array of SynchronizationObject

同步对象。

NewSchemaName String newdtstestdatabase

待同步的库在目标数据库中映射的名称。

SchemaName String dtstestdatabase

待同步的库名。

TableExcludes Array of TableExclude

待同步库中排除的表,这些表将不会被同步。

TableName String order

排除的表的名称。

TableIncludes Array of TableInclude

待同步的表。

TableName String customer

待同步表名。

TaskId String exjk1alb116****

数据同步任务ID,可用于配置控制台任务详情页面的链接。

说明 同步任务详情页的链接为:https://dts.console.aliyun.com/#/syncmore/exjk1alb116/config/ 。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationJobStatus
&SynchronizationJobId=dtsexjk1alb116****
&<公共请求参数>

正常返回示例

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

错误码

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