通過DescribeSynchronizationJobs查詢數(shù)據(jù)同步實例列表和各同步實例的詳情。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeSynchronizationJobs |
系統(tǒng)規(guī)定參數(shù)，取值：DescribeSynchronizationJobs。 |
| Tag.N.Key | String | 是 | testkey1 |
標簽鍵，可以通過調(diào)用ListTagResources接口查詢。 說明
|
| RegionId | String | 否 | cn-hangzhou |
數(shù)據(jù)同步實例所在地域的ID，詳情請參見支持的地域列表。 |
| PageSize | Integer | 否 | 30 |
每頁記錄數(shù)，取值： 30、50、100，默認值為30。 |
| PageNum | Integer | 否 | 1 |
頁碼，取值為大于0且不超過Integer數(shù)據(jù)類型的最大值，默認值為1。 |
| SynchronizationJobName | String | 否 | MySQL同步 |
同步實例名稱。 說明 支持模糊查詢。
|
| ClientToken | String | 否 | 0c593ea1-3bea-11e9-b96b-88e9fe63**** |
保證請求冪等性。從您的客戶端生成一個參數(shù)值，確保不同請求間該參數(shù)值唯一。ClientToken只支持ASCII字符，且不能超過64個字符。 |
| AccountId | String | 否 | 12323344**** |
阿里云主賬號ID，無需設(shè)置，該參數(shù)即將下線。 |
| Tag.N.Value | String | 否 | testvalue1 |
標簽的值，可以通過調(diào)用ListTagResources接口查詢。 說明
|
返回數(shù)據(jù)
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| PageNumber | Integer | 1 |
頁碼。 |
| PageRecordCount | Integer | 30 |
當前頁可展示的最大記錄數(shù)。 |
| RequestId | String | 92E1E99D-5224-4AD3-8C94-23A3516B**** |
請求ID。 |
| SynchronizationInstances | Array of SynchronizationInstance |
數(shù)據(jù)同步實例列表和各同步實例的詳情。 |
|
| CreateTime | String | 2021-06-28 17:34:53.0 |
同步任務(wù)創(chuàng)建時間，yyyy-MM-dd HH:mm:ss.0（北京時間）。 |
| DataInitialization | String | true |
是否執(zhí)行全量數(shù)據(jù)初始化，取值：
|
| DataInitializationStatus | Struct |
全量數(shù)據(jù)初始化狀態(tài)。 |
|
| ErrorMessage | String | java.lang.NumberFormatException: For input string: "" |
全量數(shù)據(jù)初始化失敗的錯誤提示。 |
| Percent | String | 100 |
全量數(shù)據(jù)初始化進度，單位為百分比。 |
| Progress | String | 200001 |
已完成全量數(shù)據(jù)初始化的記錄數(shù)。 |
| Status | String | Finished |
全量數(shù)據(jù)初始化狀態(tài)，取值包括：
|
| DataSynchronizationStatus | Struct |
增量數(shù)據(jù)同步狀態(tài)。 說明 本參數(shù)集合及所包含的參數(shù)已下線。
|
|
| Delay | String | 0 |
增量數(shù)據(jù)同步延遲。 說明 本參數(shù)已下線。
|
| ErrorMessage | String | 任務(wù)失敗太久無法恢復(fù) |
增量數(shù)據(jù)同步失敗的錯誤提示。 說明 本參數(shù)已下線。
|
| Percent | String | 100 |
增量數(shù)據(jù)同步進度。 說明 本參數(shù)已下線。
|
| Status | String | Finished |
增量數(shù)據(jù)同步狀態(tài)。 說明 本參數(shù)已下線。
|
| Delay | String | 0 |
同步延遲，單位為秒。 |
| DestinationEndpoint | Struct |
目標實例的連接信息。 |
|
| EngineName | String | MySQL |
目標實例的數(shù)據(jù)庫類型。 |
| IP | String | 172.16.88.*** |
目標實例的連接地址。 |
| InstanceId | String | rm-bp162d4tp0500**** |
目標實例ID。 |
| InstanceType | String | RDS |
目標實例類型。 |
| Port | String | 3306 |
目標實例的數(shù)據(jù)庫服務(wù)端口。 |
| UserName | String | dtstest |
目標實例的數(shù)據(jù)庫賬號。 |
| 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]. |
數(shù)據(jù)同步失敗的錯誤提示。 |
| ExpireTime | String | 2021-07-07T16:00:00Z |
同步實例的到期時間，yyyy-MM-ddTHH:mm:ssZ（UTC時間）。 說明 當PayType參數(shù)的返回值為PrePaid時才會返回本參數(shù)。
|
| InstanceCreateTime | String | 2021-06-28T09:36:32Z |
同步實例創(chuàng)建時間，yyyy-MM-ddTHH:mm:ssZ（UTC時間）。 |
| JobCreateTime | String | 2021-06-28T09:34:53Z |
同步任務(wù)創(chuàng)建時間，yyyy-MM-ddTHH:mm:ssZ（UTC時間）。 |
| PayType | String | PrePaid |
同步實例的付費類型，返回值：
|
| Performance | Struct |
同步鏈路概況信息。 |
|
| FLOW | String | 1 |
每秒同步數(shù)據(jù)的流量，單位為MB/s。 |
| RPS | String | 100 |
每秒同步SQL語句的次數(shù)，包括BEGIN、COMMIT 、DML語句（INSERT、DELETE、UPDATE）及DDL語句。 |
| PrecheckStatus | Struct |
預(yù)檢查狀態(tài)。 |
|
| Detail | Array of CheckItem |
各預(yù)檢查項的執(zhí)行情況。 |
|
| CheckStatus | String | Success |
檢查結(jié)果，返回值：
|
| ErrorMessage | String | Original error: Access denied for user 'dtstest'@'100.104.***.**' (using password: YES) |
預(yù)檢查未通過的錯誤提示。 說明 當CheckStatus參數(shù)返回值為Failed時，才會返回本參數(shù)。
|
| ItemName | String | CHECK_CONN_SRC |
預(yù)檢查項目。 |
| RepairMethod | String | CHECK_ERROR_DEST_CONN_REPAIR2 |
預(yù)檢查未通過時對應(yīng)的修復(fù)方法。 說明 當CheckStatus參數(shù)返回值為Failed時，才會返回本參數(shù)。
|
| Percent | String | 100 |
預(yù)檢查整體進度，單位為百分比。 |
| Status | String | Success |
預(yù)檢查結(jié)果，返回值：
|
| SourceEndpoint | Struct |
源實例連接信息。 |
|
| EngineName | String | MySQL |
源實例的數(shù)據(jù)庫類型。 |
| IP | String | 172.16.88.*** |
源實例的連接地址。 |
| InstanceId | String | rm-bp1i99e8l7913**** |
源實例ID。 |
| InstanceType | String | RDS |
源實例類型。 |
| Port | String | 3306 |
源實例的數(shù)據(jù)庫服務(wù)端口。 |
| UserName | String | dtstest |
源實例的數(shù)據(jù)庫賬號。 |
| Status | String | synchronizing |
同步實例的狀態(tài)，返回值：
|
| StructureInitialization | String | true |
是否執(zhí)行結(jié)構(gòu)初始化，返回值：
|
| StructureInitializationStatus | Struct |
結(jié)構(gòu)初始化狀態(tài)。 |
|
| ErrorMessage | String | DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist; |
結(jié)構(gòu)初始化失敗的錯誤提示。 |
| Percent | String | 100 |
結(jié)構(gòu)初始化進度，單位為百分比。 |
| Progress | String | 1 |
已完成結(jié)構(gòu)初始化的表的數(shù)量。 |
| Status | String | Finished |
結(jié)構(gòu)初始化狀態(tài)，取值包括：
|
| SynchronizationDirection | String | Forward |
同步方向，返回值：
|
| SynchronizationJobClass | String | large |
同步鏈路規(guī)格。 |
| SynchronizationJobId | String | dtsexjk1alb116**** |
數(shù)據(jù)同步實例ID。 |
| SynchronizationJobName | String | MySQL同步 |
同步實例名稱。 |
| SynchronizationObjects | Array of SynchronizationObject |
同步對象。 |
|
| NewSchemaName | String | newdtstestdatabase |
待同步的庫在目標數(shù)據(jù)庫中映射的名稱。 |
| SchemaName | String | dtstestdatabase |
待同步的庫名。 |
| TableExcludes | Array of TableExclude |
待同步庫中排除的表，這些表將不會被同步。 |
|
| TableName | String | order |
排除的表的名稱。 |
| TableIncludes | Array of TableInclude |
待同步的表。 |
|
| TableName | String | customer |
待同步表名。 |
| Tags | Array of Tag |
標簽集合。 |
|
| Key | String | testkey1 |
標簽鍵。 |
| Value | String | testvalue1 |
標簽鍵對應(yīng)的標簽值。 |
| TotalRecordCount | Long | 100 |
阿里云主賬號下所有符合條件的數(shù)據(jù)同步實例數(shù)量。 |
示例
請求示例
http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationJobs
&Tag.1.Key=testkey1
&<公共請求參數(shù)>正常返回示例
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同步</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格式
{
"TotalRecordCount": 100,
"SynchronizationInstances": [
{
"Status": "synchronizing",
"SynchronizationObjects": [
{
"TableIncludes": [],
"TableExcludes": [],
"SchemaName": "dtstestdatabase",
"NewSchemaName": "newdtstestdatabase"
}
],
"DataInitializationStatus": {
"Status": "Finished",
"Progress": "200001",
"Percent": "100"
},
"SynchronizationJobName": "MySQL同步",
"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
}錯誤碼
訪問錯誤中心查看更多錯誤碼。