透過 DTS API 追蹤同步物件變更狀態 - 資料傳輸服務

調用本介面前，您需要成功調用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"
	}
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。