查詢資料同步執行個體列表及各執行個體詳情 - Data Transmission Service

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	DescribeSynchronizationJobs	系統規定參數，取值：DescribeSynchronizationJobs。
Tag.N.Key	String	是	testkey1	標籤鍵，可以通過調用ListTagResources介面查詢。說明 N表示第幾個標籤的鍵。例如：Tag.1.Key表示第一個標籤的鍵；Tag.2.Key表示第二個標籤的鍵。可以同時傳入1~20個標籤鍵。該參數傳入時不允許傳入Null 字元串。
RegionId	String	否	cn-hangzhou	資料同步執行個體所在地區的ID，詳情請參見支援的地區列表。
PageSize	Integer	否	30	每頁記錄數，取值： 30、50、100，預設值為30。
PageNum	Integer	否	1	頁碼，取值為大於0且不超過Integer資料類型的最大值，預設值為1。
SynchronizationJobName	String	否	MySQL同步	同步執行個體名稱。說明支援模糊查詢。
ClientToken	String	否	0c593ea1-3bea-11e9-b96b-88e9fe63****	保證請求等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken只支援ASCII字元，且不能超過64個字元。
AccountId	String	否	12323344****	阿里雲主帳號ID，無需設定，該參數即將下線。
Tag.N.Value	String	否	testvalue1	標籤的值，可以通過調用ListTagResources介面查詢。說明 N表示第幾個標籤的值。例如：Tag.1.Value表示第一個標籤的值；Tag.2.Value表示第二個標籤的值。可以同時傳入1~20個標籤值。允許傳入Null 字元串。

返回資料

名稱	類型	樣本值	描述
PageNumber	Integer	1	頁碼。
PageRecordCount	Integer	30	當前頁可展示的最大記錄數。
RequestId	String	92E1E99D-5224-4AD3-8C94-23A3516B****	請求ID。
SynchronizationInstances	Array of SynchronizationInstance		資料同步執行個體列表和各同步執行個體的詳情。
CreateTime	String	2021-06-28 17:34:53.0	同步任務建立時間，yyyy-MM-dd HH:mm:ss.0（北京時間）。
DataInitialization	String	true	是否執行全量資料初始化，取值： true：是。 false：否。
DataInitializationStatus	Struct		全量資料初始化狀態。
ErrorMessage	String	java.lang.NumberFormatException: For input string: ""	全量資料初始化失敗的錯誤提示。
Percent	String	100	全量資料初始化進度，單位為百分比。
Progress	String	200001	已完成全量資料初始化的記錄數。
Status	String	Finished	全量資料初始化狀態，取值包括： NotStarted：未初始化。 Migrating：初始化中。 Failed：初始化失敗。 Finished：初始化完成。
DataSynchronizationStatus	Struct		增量資料同步狀態。說明本參數集合及所包含的參數已下線。
Delay	String	0	增量資料同步延遲。說明本參數已下線。
ErrorMessage	String	任務失敗太久無法恢複	增量資料同步失敗的錯誤提示。說明本參數已下線。
Percent	String	100	增量資料同步進度。說明本參數已下線。
Status	String	Finished	增量資料同步狀態。說明本參數已下線。
Delay	String	0	同步延遲，單位為秒。
DestinationEndpoint	Struct		目標執行個體的串連資訊。
EngineName	String	MySQL	目標執行個體的資料庫類型。
IP	String	172.16.88.***	目標執行個體的串連地址。
InstanceId	String	rm-bp162d4tp0500****	目標執行個體ID。
InstanceType	String	RDS	目標執行個體類型。
Port	String	3306	目標執行個體的資料庫服務連接埠。
UserName	String	dtstest	目標執行個體的資料庫帳號。
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].	資料同步失敗的錯誤提示。
ExpireTime	String	2021-07-07T16:00:00Z	同步執行個體的到期時間，yyyy-MM-ddTHH:mm:ssZ（UTC時間）。說明當PayType參數的傳回值為PrePaid時才會返回本參數。
InstanceCreateTime	String	2021-06-28T09:36:32Z	同步執行個體建立時間，yyyy-MM-ddTHH:mm:ssZ（UTC時間）。
JobCreateTime	String	2021-06-28T09:34:53Z	同步任務建立時間，yyyy-MM-ddTHH:mm:ssZ（UTC時間）。
PayType	String	PrePaid	同步執行個體的付費類型，傳回值： PrePaid：訂用帳戶（預付費）。 PostPaid：隨用隨付（後付費）。
Performance	Struct		同步鏈路概況資訊。
FLOW	String	1	每秒同步資料的流量，單位為MB/s。
RPS	String	100	每秒同步SQL語句的次數，包括BEGIN、COMMIT 、DML語句（INSERT、DELETE、UPDATE）及DDL語句。
PrecheckStatus	Struct		預檢查狀態。
Detail	Array of CheckItem		各預檢查項的執行情況。
CheckStatus	String	Success	檢查結果，傳回值： Success：通過該項檢查。 Failed：未通過該項檢查。
ErrorMessage	String	Original error: Access denied for user 'dtstest'@'100.104.*.' (using password: YES)	預檢查未通過的錯誤提示。說明當CheckStatus參數傳回值為Failed時，才會返回本參數。
ItemName	String	CHECK_CONN_SRC	預檢查專案。
RepairMethod	String	CHECK_ERROR_DEST_CONN_REPAIR2	預檢查未通過時對應的修複方法。說明當CheckStatus參數傳回值為Failed時，才會返回本參數。
Percent	String	100	預檢查整體進度，單位為百分比。
Status	String	Success	預檢查結果，傳回值： Success：通過該項檢查。 Failed：未通過該項檢查。
SourceEndpoint	Struct		源執行個體串連資訊。
EngineName	String	MySQL	源執行個體的資料庫類型。
IP	String	172.16.88.***	源執行個體的串連地址。
InstanceId	String	rm-bp1i99e8l7913****	源執行個體ID。
InstanceType	String	RDS	源執行個體類型。
Port	String	3306	源執行個體的資料庫服務連接埠。
UserName	String	dtstest	源執行個體的資料庫帳號。
Status	String	synchronizing	同步執行個體的狀態，傳回值： NotStarted：未啟動。 Prechecking：預檢查中。 PrecheckFailed：預檢查失敗。 Initializating ：同步初始化。 InitializeFailed：同步初始化失敗。 Synchronizing ：同步中。 Failed：同步失敗。 Suspending：暫停。 Modifying：同步對象變更中。 Finished：完成。
StructureInitialization	String	true	是否執行結構初始化，傳回值： true：是 false：否
StructureInitializationStatus	Struct		結構初始化狀態。
ErrorMessage	String	DTS-1020042 Execute sql error sql: ERROR: type "geometry" does not exist;	結構初始化失敗的錯誤提示。
Percent	String	100	結構初始化進度，單位為百分比。
Progress	String	1	已完成結構初始化的表的數量。
Status	String	Finished	結構初始化狀態，取值包括： NotStarted：未啟動。 Migrating ：初始化中。 Failed ：初始化失敗。 Finished：初始化完成。
SynchronizationDirection	String	Forward	同步方向，傳回值： Forward：正向。 Reverse：反向。
SynchronizationJobClass	String	large	同步鏈路規格。
SynchronizationJobId	String	dtsexjk1alb116****	資料同步執行個體ID。
SynchronizationJobName	String	MySQL同步	同步執行個體名稱。
SynchronizationObjects	Array of SynchronizationObject		同步對象。
NewSchemaName	String	newdtstestdatabase	待同步的庫在目標資料庫中映射的名稱。
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	標籤鍵對應的標籤值。
TotalRecordCount	Long	100	阿里雲主帳號下所有合格資料同步執行個體數量。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=DescribeSynchronizationJobs
&Tag.1.Key=testkey1
&<公用請求參數>

正常返回樣本

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
}

錯誤碼

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