DescribeSynchronizationObjectModifyStatus - Data Transmission Service

Before you call this operation, you must call the ModifySynchronizationObject operation to obtain the task ID.

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	DescribeSynchronizationObjectModifyStatus	The operation that you want to perform. Set the value to DescribeSynchronizationObjectModifyStatus.
TaskId	String	Yes	k71r16fj13g****	The task ID, which is returned after you call the ModifySynchronizationObject operation to modify the objects to be synchronized.
RegionId	String	No	cn-hangzhou	The ID of the region where the data synchronization instance resides. For more information, see List of supported regions.
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.

Response parameters


Parameter	Type	Example	Description
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	39754	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 will be removed in the future.
Delay	String	0	The synchronization latency, in seconds.
ErrorMessage	String	The task has failed for a long time and cannot be recovered.	The error message returned if incremental data synchronization failed.
Percent	String	100	The progress of incremental data synchronization. Unit: %.
Status	String	Migrating	The status of incremental data synchronization. Valid values: NotStarted: Incremental data synchronization is not started. Migrating: Incremental data synchronization is in progress. Failed: Incremental data synchronization failed. Finished: Incremental data synchronization is completed.
ErrCode	String	InternalError	The error code returned if the call failed.
ErrMessage	String	The request processing has failed due to some unknown error.	The error message returned if the call failed.
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 the task failed to modify the objects to be synchronized.
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.xxx.xx' (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	Finished	The precheck status.
RequestId	String	B38C644B-4395-4F6F-86E3-592F26BE****	The ID of the request.
Status	String	Finished	The status of the task that changes the objects to be synchronized. Valid values: NotStarted: The task is not started. Prechecking: The task is being prechecked. PrecheckFailed: The task failed to pass the precheck. Migrating: The task is running. Failed: The task failed. Finished: The task is completed.
StructureInitializationStatus	Struct		The status of schema synchronization.
ErrorMessage	String	DTS-1020042 Execute sql error sql: Table 'customer' already exists	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.
Success	String	true	Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationObjectModifyStatus
&TaskId=k71r16fj13g****
&<Common request parameters>

Sample success responses

XML format

<Status>Migrating</Status>
<PrecheckStatus>
    <Status>Finished</Status>
    <Percent>100</Percent>
    <Detail>
        <CheckStatus>Success</CheckStatus>
        <ItemName>CHECK_CONN_SRC</ItemName>
    </Detail>
    <Detail>
        <CheckStatus>Success</CheckStatus>
        <ItemName>CHECK_CONN_DEST</ItemName>
    </Detail>
    <Detail>
        <CheckStatus>Success</CheckStatus>
        <ItemName>CHECK_AUTH_SRC</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>
<DataInitializationStatus>
    <Status>Finished</Status>
    <Progress>0</Progress>
    <Percent>100</Percent>
</DataInitializationStatus>
<RequestId>0C3D6348-79D8-43F8-9788-60C30CCC****</RequestId>
<Success>true</Success>
<StructureInitializationStatus>
    <Status>Finished</Status>
    <Progress>0</Progress>
    <Percent>100</Percent>
</StructureInitializationStatus>

JSON format

{
    "Status": "Migrating",
    "PrecheckStatus": {
        "Status": "Finished",
        "Percent": "100",
        "Detail": [
            {
                "CheckStatus": "Success",
                "ItemName": "CHECK_CONN_SRC"
            },
            {
                "CheckStatus": "Success",
                "ItemName": "CHECK_CONN_DEST"
            },
            {
                "CheckStatus": "Success",
                "ItemName": "CHECK_AUTH_SRC"
            },
            {
                "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"
            }
        ]
    },
    "DataInitializationStatus": {
        "Status": "Finished",
        "Progress": "0",
        "Percent": "100"
    },
    "RequestId": "0C3D6348-79D8-43F8-9788-60C30CCC****",
    "Success": true,
    "StructureInitializationStatus": {
        "Status": "Finished",
        "Progress": "0",
        "Percent": "100"
    }
}

Error codes

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