Queries the list of data synchronization instances and the details of each instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSynchronizationJobs

The operation that you want to perform. Set the value to DescribeSynchronizationJobs.

Tag.N.Key String Yes testkey1

The tag key. You can call the ListTagResources operation to query the tag key.

Note
  • N specifies the serial number of the tag. For example, Tag.1.Key specifies the key of the first tag and Tag.2.Key specifies the key of the second tag. You can specify 1 to 20 tag keys at a time.
  • This parameter cannot be an empty string.
RegionId String No cn-hangzhou

The ID of the region where the data synchronization instance resides. For more information, see List of supported regions.

PageSize Integer No 30

The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.

PageNum Integer No 1

The number of the page to return. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: 1.

SynchronizationJobName String No MySQL Synchronization

The name of the data synchronization task.

Note Fuzzy matching is supported.
ClientToken String No 0c593ea1-3bea-11e9-b96b-88e9fe63****

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length.

AccountId String No 12323344****

The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter will be removed in the future.

Tag.N.Value String No testvalue1

The tag value. You can call the ListTagResources operation to query the tag value.

Note
  • N specifies the serial number of the tag. For example, Tag.1.Value specifies the value of the first tag and Tag.2.Value specifies the value of the second tag. You can specify 1 to 20 tag values at a time.
  • This parameter can be an empty string.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageRecordCount Integer 30

The maximum number of entries that can be displayed on the current page.

RequestId String 92E1E99D-5224-4AD3-8C94-23A3516B****

The ID of the request.

SynchronizationInstances Array of SynchronizationInstance

The list of data synchronization instances and the details of each instance.

CreateTime String 2021-06-28 17:34:53.0

The time when the data synchronization task was created. The time is displayed in the yyyy-MM-dd HH:mm:ss.0 format (UTC+8).

DataInitialization String true

Indicates whether full data synchronization is performed. Valid values:

  • true: yes
  • false: no
DataInitializationStatus Struct

The status of full data synchronization.

ErrorMessage String java.lang.NumberFormatException: For input string: ""

The error message returned if full data synchronization failed.

Percent String 100

The progress of full data synchronization. Unit: %.

Progress String 200001

The number of records that have been synchronized during full data synchronization.

Status String Finished

The status of full data synchronization. Valid values:

  • NotStarted: Full data synchronization is not started.
  • Migrating: Full data synchronization is in progress.
  • Failed: Full data synchronization failed.
  • Finished: Full data synchronization is completed.
DataSynchronizationStatus Struct

The status of incremental data synchronization.

Note This parameter and its sub-parameters are no longer available.
Delay String 0

The synchronization latency.

Note This parameter is no longer available.
ErrorMessage String The task has failed for a long time and cannot be recovered.

The error message returned if incremental data synchronization failed.

Note This parameter is no longer available.
Percent String 100

The progress of incremental data synchronization. Unit: %.

Note This parameter is no longer available.
Status String Finished

The status of incremental data synchronization.

Note This parameter is no longer available.
Delay String 0

The synchronization latency, in seconds.

DestinationEndpoint Struct

The connection settings of the destination instance.

EngineName String MySQL

The database type of the destination instance.

IP String 172.16.88.***

The endpoint of the destination instance.

InstanceId String rm-bp162d4tp0500****

The ID of the destination instance.

InstanceType String RDS

The type of the destination instance.

Port String 3306

The database service port of the destination instance.

UserName String dtstest

The database account of the destination instance.

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

The error message returned if data synchronization failed.

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

The time when the data synchronization instance expires. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

Note This parameter is returned only if the return value of the PayType parameter is PrePaid.
InstanceCreateTime String 2021-06-28T09:36:32Z

The time when the instance was created. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

JobCreateTime String 2021-06-28T09:34:53Z

The time when the data synchronization task was created. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.

PayType String PrePaid

The billing method of the data synchronization instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
Performance Struct

The performance of the data synchronization instance.

FLOW String 1

The data traffic that is synchronized per second. Unit: MB/s.

RPS String 100

The number of times SQL statements are synchronized per second, including BEGIN, COMMIT, DML, and DDL statements. DML statements include INSERT, DELETE, and UPDATE.

PrecheckStatus Struct

The precheck status.

Detail Array of CheckItem

The result of each precheck item.

CheckStatus String Success

The precheck result. Valid values:

  • Success: The task passed the precheck.
  • Failed: The task failed to pass the precheck.
ErrorMessage String Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES)

The error message returned if the task failed to pass the precheck.

Note This parameter is returned only if the return value of the CheckStatus parameter is Failed.
ItemName String CHECK_CONN_SRC

The name of the precheck item.

RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

The method to fix the precheck failure.

Note This parameter is returned only if the return value of the CheckStatus parameter is Failed.
Percent String 100

The precheck progress. Unit: %.

Status String Success

The precheck result. Valid values:

  • Success: The task passed the precheck.
  • Failed: The task failed to pass the precheck.
SourceEndpoint Struct

The connection settings of the source instance.

EngineName String MySQL

The database type of the source instance.

IP String 172.16.88.***

The endpoint of the source instance.

InstanceId String rm-bp1i99e8l7913****

The ID of the source instance.

InstanceType String RDS

The type of the source instance.

Port String 3306

The database service port of the source instance.

UserName String dtstest

The database account of the source instance.

Status String synchronizing

The status of the data synchronization task. Valid values:

  • NotStarted: The task is not started.
  • Prechecking: The task is being prechecked.
  • PrecheckFailed: The task failed to pass the precheck.
  • Initializing: The task is performing initial synchronization.
  • InitializeFailed: Initial synchronization failed.
  • Synchronizing: The task is synchronizing data.
  • Failed: The task failed to synchronize data.
  • Suspending: The task is paused.
  • Modifying: The objects in the task are being modified.
  • Finished: The task is completed.
StructureInitialization String true

Indicates whether schema synchronization is performed. Valid values:

  • true: yes
  • false: no
StructureInitializationStatus Struct

The status of schema synchronization.

ErrorMessage String DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;

The error message returned if schema synchronization failed.

Percent String 100

The progress of schema synchronization. Unit: %.

Progress String 1

The number of tables whose schemas have been synchronized.

Status String Finished

The status of schema synchronization. Valid values:

  • NotStarted: Schema synchronization is not started.
  • Migrating: Schema synchronization is in progress.
  • Failed: Schema synchronization failed.
  • Finished: Schema synchronization is completed.
SynchronizationDirection String Forward

The synchronization direction. Valid values:

  • Forward
  • Reverse
SynchronizationJobClass String large

The specification of the data synchronization instance.

SynchronizationJobId String dtsexjk1alb116****

The ID of the data synchronization instance.

SynchronizationJobName String MySQL Synchronization

The name of the data synchronization task.

SynchronizationObjects Array of SynchronizationObject

The objects that are synchronized by the task.

NewSchemaName String newdtstestdatabase

The database name that is used in the destination instance.

SchemaName String dtstestdatabase

The name of the synchronized database.

TableExcludes Array of TableExclude

The source tables that are excluded from the data synchronization task.

TableName String order

The name of the excluded table.

TableIncludes Array of TableInclude

The tables that are synchronized by the task.

TableName String customer

The name of the synchronized table.

Tags Array of Tag

The collection of tags.

Key String testkey1

The tag key.

Value String testvalue1

The tag value that corresponds to the tag key.

TotalRecordCount Long 100

The total number of data synchronization instances that belong to your Alibaba Cloud account.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationJobs
&Tag.1.Key=testkey1
&<Common request parameters>

Sample success responses

XML format 

<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 Synchronization</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></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 format 

{
    "TotalRecordCount": 100,
    "SynchronizationInstances": [
        {
            "Status": "synchronizing",
            "SynchronizationObjects": [
                {
                    "TableIncludes": [],
                    "TableExcludes": [],
                    "SchemaName": "dtstestdatabase",
                    "NewSchemaName": "newdtstestdatabase"
                }
            ],
            "DataInitializationStatus": {
                "Status": "Finished",
                "Progress": "200001",
                "Percent": "100"
            },
            "SynchronizationJobName": "MySQL Synchronization",
            "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
}

Error codes

For a list of error codes, visit the API Error Center.