DescribeSynchronizationJobs - Data Transmission Service - Alibaba Cloud Documentation Center

Use this API to get a list of data synchronization instances and their details.

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 API action. Valid value: `DescribeSynchronizationJobs`
RegionId	String	No	cn-hangzhou	The region ID of the data synchronization instance. For more information, see List of supported regions.
PageSize	Integer	No	30	The number of entries to return on each page. Valid values: 10, 20, and 30. Default value: 30. Maximum value: 30.
PageNum	Integer	No	1	The page number. The value must be 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****	A unique value generated by the client for each request to ensure its idempotency. It supports only ASCII characters and cannot exceed 64 characters.
AccountId	String	No	12323344****	Your Alibaba Cloud account ID. You don't need to set this as it will be deprecated soon.
Tag.N.Key	String	Yes	testkey1	The tag key. You can get it by calling the ListTagResources API. 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.
Tag.N.Value	String	No	testvalue1	The tag value. You can get it by calling the ListTagResources API. 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. The tag value can be an empty string.
ResourceGroupId	String	No	rg-acfmzawhxxc****	The resource group ID.

Response parameters

Parameter	Type	Example	Description
PageNumber	Integer	1	The page number of the returned results.
RequestId	String	92E1E99D-5224-4AD3-8C94-23A3516B****	The unique request ID.
PageRecordCount	Integer	30	The maximum number of entries that can be displayed on the current page.
TotalRecordCount	Long	100	The total number of data synchronization instances that belong to your Alibaba Cloud account.
SynchronizationInstances	Array of SynchronizationInstance		The list of data synchronization instances and their details.
DataInitialization	String	true	Indicates whether full data synchronization is performed. Valid values: `true`: yes. `false`: no.
Status	String	synchronizing	The current 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. `Initializating` : 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.
SynchronizationJobName	String	MySQL Synchronization	The name of the data synchronization task.
Delay	String	0	The synchronization latency. Unit: seconds.
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 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`.
CreateTime	String	2021-06-28 17:34:53.0	The time when the data synchronization task was created in the yyyy-MM-dd HH:mm:ss.0 format (UTC+8).
PayType	String	PrePaid	The billing method of the data synchronization instance. Valid values: `PrePaid`: subscription. `PostPaid`: pay-as-you-go.
StructureInitialization	String	true	Indicates whether schema synchronization is performed. Valid values: `true`: yes `false`: no
SynchronizationJobClass	String	large	The specification of the data synchronization instance.
InstanceCreateTime	String	2021-06-28T09:36:32Z	The time when the instance was created in the yyyy-MM-ddTHH:mm:ssZ format in UTC.
SynchronizationJobId	String	dtsexjk1alb116****	The ID of the data synchronization instance.
SynchronizationDirection	String	Forward	The synchronization direction. Valid values: Forward: forward. Reverse: reverse.
JobCreateTime	String	2021-06-28T09:34:53Z	The time when the data synchronization task was created in the yyyy-MM-ddTHH:mm:ssZ format in UTC.
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.
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.
DataInitializationStatus	Object		The state of full data synchronization.
Status	String	Finished	The state 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.
Percent	String	100	The progress of full data synchronization. Unit: %.
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	The error message returned if full data synchronization failed.
Progress	String	200001	The number of entries that have been synchronized during full data synchronization.
DataSynchronizationStatus	Object		The state of incremental data synchronization. Note This parameter and its sub-parameters are no longer available.
Status	String	Finished	The state of incremental data synchronization. Note This parameter is no longer available.
Delay	String	0	The latency of incremental data synchronization. Note This parameter is no longer available.
Percent	String	100	The progress of incremental data synchronization. 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.
DestinationEndpoint	Object		The connection settings of the destination instance.
InstanceId	String	rm-bp162d4tp0500****	The ID of the destination instance.
IP	String	172.16.88.***	The endpoint 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.
EngineName	String	MySQL	The database type of the destination instance.
Performance	Object		The performance of the data synchronization instance.
RPS	String	100	The number of SQL statements that are synchronized per second, including `BEGIN`, `COMMIT`, `DML`, and `DDL` statements. DML statements include `INSERT`, `DELETE`, and `UPDATE`.
FLOW	String	1	The data traffic that is synchronized per second. Unit: MB/s.
PrecheckStatus	Object		The precheck status.
Status	String	Success	The precheck result. Valid values: `Success`: The task passed the precheck. `Failed`: The task failed to pass the precheck.
Percent	String	100	The precheck progress. Unit: %.
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`.
SourceEndpoint	Object		The connection settings of the source instance.
InstanceId	String	rm-bp1i99e8l7913****	The ID of the source instance.
IP	String	172.16.88.***	The endpoint 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.
EngineName	String	MySQL	The database type of the source instance.
StructureInitializationStatus	Object		The state of schema synchronization.
Status	String	Finished	The state 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.
Percent	String	100	The progress of schema synchronization. Unit: %.
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	The error message returned if schema synchronization failed.
Progress	String	1	The number of tables whose schemas have been synchronized.

Examples

Sample requests

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

Sample success responses

XML format

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

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

HttpCode	Error code	Error message	Description
400	Throttling.User	Request was denied due to user flow control.	The number of requests reached the limit, and the request was rejected. Try again later.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	The signature expired. Use a new signature.

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