通过DescribeSynchronizationJobs查询数据同步实例列表和各同步实例的详情

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSynchronizationJobs	系统规定参数。取值：DescribeSynchronizationJobs。
RegionId	String	否	cn-hangzhou	数据同步实例所在地域的ID，详情请参见支持的地域列表。
PageSize	Integer	否	30	每页记录数。取值为： 10、20、30，默认值为30，最大值为30。
PageNum	Integer	否	1	页码，取值为大于0且不超过Integer数据类型的最大值，默认值为1。
SynchronizationJobName	String	否	MySQL同步	同步实例名称。说明支持模糊查询。
ClientToken	String	否	0c593ea1-3bea-11e9-b96b-88e9fe63****	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。
AccountId	String	否	12323344****	阿里云主账号ID，无需设置，该参数即将下线。
Tag.N.Key	String	是	testkey1	标签键，可以通过调用ListTagResources接口查询。说明 N表示第几个标签的键。例如：Tag.1.Key表示第一个标签的键；Tag.2.Key表示第二个标签的键。可以同时传入1~20个标签键。该参数传入时不允许传入空字符串。
Tag.N.Value	String	否	testvalue1	标签的值，可以通过调用ListTagResources接口查询。说明 N表示第几个标签的值。例如：Tag.1.Value表示第一个标签的值；Tag.2.Value表示第二个标签的值。可以同时传入1~20个标签值。允许传入空字符串。
ResourceGroupId	String	否	rg-acfmzawhxxc****	资源组ID。

返回数据

名称	类型	示例值	描述
PageNumber	Integer	1	页码。
RequestId	String	92E1E99D-5224-4AD3-8C94-23A3516B****	请求ID。
PageRecordCount	Integer	30	当前页可展示的最大记录数。
TotalRecordCount	Long	100	阿里云主账号下所有符合条件的数据同步实例数量。
SynchronizationInstances	Array of SynchronizationInstance		数据同步实例列表和各同步实例的详情。
DataInitialization	String	true	是否执行全量数据初始化，取值： true：是。 false：否。
Status	String	synchronizing	同步实例的状态，返回值： NotStarted：未启动。 Prechecking：预检查中。 PrecheckFailed：预检查失败。 Initializating ：同步初始化。 InitializeFailed：同步初始化失败。 Synchronizing ：同步中。 Failed：同步失败。 Suspending：暂停。 Modifying：同步对象变更中。 Finished：完成。
SynchronizationJobName	String	MySQL同步	同步实例名称。
Delay	String	0	同步延迟，单位为秒。
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-07-07T16:00:00Z	同步实例的到期时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。说明当PayType参数的返回值为PrePaid时才会返回本参数。
CreateTime	String	2021-06-28 17:34:53.0	同步任务创建时间，yyyy-MM-dd HH:mm:ss.0（北京时间）。
PayType	String	PrePaid	同步实例的付费类型，返回值： PrePaid：包年包月（预付费）。 PostPaid：按量付费（后付费）。
StructureInitialization	String	true	是否执行结构初始化，返回值： true：是 false：否
SynchronizationJobClass	String	large	同步链路规格。
InstanceCreateTime	String	2021-06-28T09:36:32Z	同步实例创建时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
SynchronizationJobId	String	dtsexjk1alb116****	数据同步实例ID。
SynchronizationDirection	String	Forward	同步方向，返回值： Forward：正向。 Reverse：反向。
JobCreateTime	String	2021-06-28T09:34:53Z	同步任务创建时间，yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
Tags	Array of Tag		标签集合。
Key	String	testkey1	标签键。
Value	String	testvalue1	标签键对应的标签值。
SynchronizationObjects	Array of SynchronizationObject		同步对象。
NewSchemaName	String	newdtstestdatabase	待同步的库在目标数据库中映射的名称。
SchemaName	String	dtstestdatabase	待同步的库名。
TableExcludes	Array of TableExclude		待同步库中排除的表，这些表将不会被同步。
TableName	String	order	排除的表的名称。
TableIncludes	Array of TableInclude		待同步的表。
TableName	String	customer	待同步表名。
DataInitializationStatus	Object		全量数据初始化状态。
Status	String	Finished	全量数据初始化状态，取值包括： NotStarted：未初始化。 Migrating：初始化中。 Failed：初始化失败。 Finished：初始化完成。
Percent	String	100	全量数据初始化进度，单位为百分比。
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	全量数据初始化失败的错误提示。
Progress	String	200001	已完成全量数据初始化的记录数。
DataSynchronizationStatus	Object		增量数据同步状态。说明本参数集合及所包含的参数已下线。
Status	String	Finished	增量数据同步状态。说明本参数已下线。
Delay	String	0	增量数据同步延迟。说明本参数已下线。
Percent	String	100	增量数据同步进度。说明本参数已下线。
ErrorMessage	String	任务失败太久无法恢复	增量数据同步失败的错误提示。说明本参数已下线。
DestinationEndpoint	Object		目标实例的连接信息。
InstanceId	String	rm-bp162d4tp0500****	目标实例ID。
IP	String	172.16.88.***	目标实例的连接地址。
InstanceType	String	RDS	目标实例类型。
Port	String	3306	目标实例的数据库服务端口。
UserName	String	dtstest	目标实例的数据库账号。
EngineName	String	MySQL	目标实例的数据库类型。
Performance	Object		同步链路概况信息。
RPS	String	100	每秒同步SQL语句的次数，包括BEGIN、COMMIT 、DML语句（INSERT、DELETE、UPDATE）及DDL语句。
FLOW	String	1	每秒同步数据的流量，单位为MB/s。
PrecheckStatus	Object		预检查状态。
Status	String	Success	预检查结果，返回值： Success：通过该项检查。 Failed：未通过该项检查。
Percent	String	100	预检查整体进度，单位为百分比。
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时，才会返回本参数。
SourceEndpoint	Object		源实例连接信息。
InstanceId	String	rm-bp1i99e8l7913****	源实例ID。
IP	String	172.16.88.***	源实例的连接地址。
InstanceType	String	RDS	源实例类型。
Port	String	3306	源实例的数据库服务端口。
UserName	String	dtstest	源实例的数据库账号。
EngineName	String	MySQL	源实例的数据库类型。
StructureInitializationStatus	Object		结构初始化状态。
Status	String	Finished	结构初始化状态，取值包括： NotStarted：未启动。 Migrating ：初始化中。 Failed ：初始化失败。 Finished：初始化完成。
Percent	String	100	结构初始化进度，单位为百分比。
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	结构初始化失败的错误提示。
Progress	String	1	已完成结构初始化的表的数量。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationJobs
&Tag.1.Key=testkey1
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSynchronizationJobsResponse>
    <TotalRecordCount>100</TotalRecordCount>
    <SynchronizationInstances>
        <Status>synchronizing</Status>
        <SynchronizationObjects>
            <SchemaName>dtstestdatabase</SchemaName>
            <NewSchemaName>newdtstestdatabase</NewSchemaName>
        </SynchronizationObjects>
        <DataInitializationStatus>
            <Status>Finished</Status>
            <Progress>200001</Progress>
            <Percent>100</Percent>
        </DataInitializationStatus>
        <SynchronizationJobName>MySQL同步</SynchronizationJobName>
        <InstanceCreateTime>2021-06-28T09:36:32Z</InstanceCreateTime>
        <CreateTime>2021-06-28 17:34:53.0</CreateTime>
        <JobCreateTime>2021-06-28T09:34:53Z</JobCreateTime>
        <PayType>PostPaid</PayType>
        <Delay>0</Delay>
        <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>
        <SynchronizationJobId>dtsexjk1alb116lbf1</SynchronizationJobId>
        <DataInitialization>true</DataInitialization>
        <DestinationEndpoint>
            <InstanceId>rm-bp162d4tp0500****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
        </DestinationEndpoint>
        <SourceEndpoint>
            <InstanceId>rm-bp1i99e8l7913****</InstanceId>
            <InstanceType>RDS</InstanceType>
            <EngineName>MySQL</EngineName>
        </SourceEndpoint>
        <StructureInitialization>true</StructureInitialization>
        <ExpireTime>2021-07-07T16:00:00Z</ExpireTime>
        <Performance>
            <RPS>0</RPS>
            <FLOW>0.00MB/s</FLOW>
        </Performance>
        <SynchronizationJobClass>large</SynchronizationJobClass>
        <DataSynchronizationStatus/>
        <StructureInitializationStatus>
            <Status>Finished</Status>
            <Progress>1</Progress>
            <Percent>100</Percent>
        </StructureInitializationStatus>
    </SynchronizationInstances>
    <PageRecordCount>30</PageRecordCount>
    <RequestId>92E1E99D-5224-4AD3-8C94-23A3516B****</RequestId>
    <PageNumber>1</PageNumber>
</DescribeSynchronizationJobsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 100,
  "SynchronizationInstances" : [ {
    "Status" : "synchronizing",
    "SynchronizationObjects" : [ {
      "TableIncludes" : [ ],
      "TableExcludes" : [ ],
      "SchemaName" : "dtstestdatabase",
      "NewSchemaName" : "newdtstestdatabase"
    } ],
    "DataInitializationStatus" : {
      "Status" : "Finished",
      "Progress" : "200001",
      "Percent" : "100"
    },
    "SynchronizationJobName" : "MySQL同步",
    "InstanceCreateTime" : "2021-06-28T09:36:32Z",
    "CreateTime" : "2021-06-28 17:34:53.0",
    "JobCreateTime" : "2021-06-28T09:34:53Z",
    "PayType" : "PostPaid",
    "Delay" : "0",
    "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"
      } ]
    },
    "SynchronizationJobId" : "dtsexjk1alb116lbf1",
    "DataInitialization" : true,
    "DestinationEndpoint" : {
      "InstanceId" : "rm-bp162d4tp0500****",
      "InstanceType" : "RDS",
      "EngineName" : "MySQL"
    },
    "SourceEndpoint" : {
      "InstanceId" : "rm-bp1i99e8l7913****",
      "InstanceType" : "RDS",
      "EngineName" : "MySQL"
    },
    "StructureInitialization" : true,
    "ExpireTime" : "2021-07-07T16:00:00Z",
    "Performance" : {
      "RPS" : "0",
      "FLOW" : "0.00MB/s"
    },
    "SynchronizationJobClass" : "large",
    "Tags" : [ ],
    "DataSynchronizationStatus" : { },
    "StructureInitializationStatus" : {
      "Status" : "Finished",
      "Progress" : "1",
      "Percent" : "100"
    }
  } ],
  "PageRecordCount" : 30,
  "RequestId" : "92E1E99D-5224-4AD3-8C94-23A3516B****",
  "PageNumber" : 1
}

错误码

HttpCode	错误码	错误信息	描述
400	Throttling.User	Request was denied due to user flow control.	由于请求频次达到阈值，请求被拒绝，请稍后重试。
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	由于服务端响应超时或者不可用导致请求失败，请重试，重试后仍失败请联系技术支持。
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	签名已经过期，请更新签名

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