调用DescribeSynchronizationObjectModifyStatus接口修改同步对象任务的执行情况。

调用本接口前,您需要成功调用ModifySynchronizationObject接口并获取到TaskId信息。

调试

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

请求参数

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

系统规定参数,取值:DescribeSynchronizationObjectModifyStatus

TaskId String k71r16fj13g****

任务ID,调用ModifySynchronizationObject接口修改同步对象时会返回该值。

RegionId String cn-hangzhou

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

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

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

AccountId String 12323344****

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

返回数据

名称 类型 示例值 描述
DataInitializationStatus Struct

全量数据初始化状态。

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

全量数据初始化失败的错误提示。

Percent String 100

全量数据初始化进度,单位为百分比。

Progress String 39754

已完成全量数据初始化的记录数。

Status String Finished

全量数据初始化状态,取值包括:

  • NotStarted:未启动。
  • Migrating :初始化中。
  • Failed:初始化失败。
  • Finished:初始化完成。
DataSynchronizationStatus Struct

增量数据同步状态。

说明 该参数合集及包含的返回参数即将下线。
Delay String 0

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

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

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

Percent String 100

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

Status String Migrating

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

  • NotStarted:未启动。
  • Migrating:同步中。
  • Failed:同步失败。
  • Finished:同步完成。
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].

修改同步对象任务失败的错误提示。

PrecheckStatus Struct

预检查状态。

Detail Array of CheckItem

各预检查项的执行情况。

CheckStatus String Success

检查结果,返回值:

  • Success:通过该项检查。
  • Failed:未通过该项检查。
ErrorMessage String Original error: Access denied for user 'dtstest'@'100.104.xxx.xx' (using password: YES)

预检查未通过的错误提示。

说明CheckStatus参数返回值为Failed时,才会返回本参数。
ItemName String CHECK_CONN_SRC

预检查项目。

RepairMethod String CHECK_ERROR_DEST_CONN_REPAIR2

预检查未通过时对应的修复方法。

说明CheckStatus参数返回值为Failed时,才会返回本参数。
Percent String 100

预检查进度,单位为百分比。

Status String Finished

预检查状态。

RequestId String B38C644B-4395-4F6F-86E3-592F26BE****

请求ID。

Status String Finished

同步对象变更状态,取值:

  • NotStarted:未启动。
  • Prechecking:预检查中。
  • PrecheckFailed:预检查失败。
  • Migrating:同步中。
  • Failed:同步失败。
  • Finished:同步完成。
StructureInitializationStatus Struct

结构初始化状态。

ErrorMessage String DTS-1020042 Execute sql error sql: Table 'customer' already exists

结构初始化失败的错误提示。

Percent String 100

结构初始化进度,单位为百分比。

Progress String 1

已完成结构初始化的表的数量。

Status String Finished

结构初始化状态,取值包括:

  • NotStarted:未启动。
  • Migrating :初始化中。
  • Failed:初始化失败。
  • Finished:初始化完成。
Success String true

请求是否成功。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationObjectModifyStatus
&TaskId=k71r16fj13g****
&<公共请求参数>

正常返回示例

XML格式

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

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

错误码

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