全部產品
Search

搜尋本產品

    Data Transmission Service：查詢訂閱執行個體列表及各執行個體詳情

    文件中心

    Data Transmission Service：查詢訂閱執行個體列表及各執行個體詳情

    更新時間：Feb 08, 2025

    調用DescribeSubscriptionInstances介面查詢訂閱執行個體列表和各訂閱執行個體詳情。

    調試

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

    請求參數

    名稱 類型 是否必選 樣本值 描述
    Action String 是 DescribeSubscriptionInstances

    系統規定參數，取值：DescribeSubscriptionInstances。
    Tag.N.Key String 是 testkey1

    標籤的鍵。

    說明
    • 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。
    SubscriptionInstanceName String 否 MySQL訂閱

    訂閱執行個體名稱。

    說明 傳入本參數後，DTS將在調用結果中返回包含該名稱的訂閱執行個體。
    ClientToken String 否 0c593ea1-3bea-11e9-b96b-88e9fe63****

    保證請求等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken只支援ASCII字元，且不能超過64個字元。
    AccountId String 否 12323344****

    阿里雲主帳號ID，無需設定，該參數即將下線。
    Tag.N.Value String 否 testvalue1

    標籤的值。

    說明
    • N表示傳入第幾個標籤的值。例如：Tag.1.Value表示傳入第一個標籤的值；Tag.2.Value表示傳入第二個標籤的值。可以同時查詢1~20個標籤值。
    • 允許傳入Null 字元串。

    返回資料

    名稱 類型 樣本值 描述
    ErrCode String InternalError

    調用出錯時返回的錯誤碼。
    ErrMessage String The request processing has failed due to some unknown error.

    調用錯誤時返回的錯誤資訊。
    PageNumber Integer 1

    頁碼。
    PageRecordCount Integer 30

    當前頁可展示的最大記錄數。
    RequestId String FC3BAAF2-74E3-4471-8EB5-96202D6A****

    請求ID。
    SubscriptionInstances Array of SubscriptionInstance

    資料訂閱執行個體列表和各訂閱執行個體的詳情。
    SubscriptionInstance
    BeginTimestamp String 2021-06-21T08:25:43Z

    訂閱執行個體儲存資料範圍的起始時間點，格式為yyyy-MM-ddTHH:mm:ssZ（UTC時間）。
    ConsumptionCheckpoint String 2021-06-21T09:30:31Z

    訂閱執行個體的下遊消費時間點，格式為yyyy-MM-ddTHH:mm:ssZ（UTC時間）。
    ConsumptionClient String 114.***.***.**:dts********

    下遊連結對應的IP和隨機標識資訊，其中IP為下遊用戶端的IP地址，隨機標示為DTS產生的隨機ID。
    EndTimestamp String 2021-06-21T10:17:21Z

    訂閱執行個體儲存資料範圍的末尾時間點，格式為yyyy-MM-ddTHH:mm:ssZ（UTC時間）。
    ErrorMessage String xxxxxxxx

    資料訂閱異常的錯誤提示。
    InstanceCreateTime String 2021-06-21T02:48:20Z

    訂閱執行個體建立時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC時間）。
    JobCreateTime String 2021-06-21T02:48:20Z

    訂閱任務建立時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC時間）。
    PayType String PrePaid

    訂閱執行個體的付費類型，傳回值：

    • PrePaid：訂用帳戶（預付費）。
    • PostPaid：隨用隨付（後付費）。
    SourceEndpoint Struct

    源執行個體的串連資訊。
    InstanceID String rm-bp1162kryivb8****

    源執行個體ID。
    InstanceType String RDS

    源執行個體類型。

    說明 當該訂閱執行個體為新版時，才會返回該參數。
    Status String Normal

    訂閱執行個體的狀態，傳回值為：

    • NotStarted：未啟動。
    • Prechecking：預檢查中。
    • PrecheckFailed：預檢查失敗。
    • Starting：啟動中。
    • Normal：正常。
    • Abnormal：異常。
    SubscribeTopic String cn_hangzhou_rm_bp1162kryivb8****_dtstest_version2

    訂閱Topic。

    說明 當該訂閱執行個體為新版，且調用CreateConsumerGroup介面建立了消費組時，才會返回本參數。
    SubscriptionDataType Struct

    訂閱資料的類型。
    DDL Boolean true

    訂閱資料是否包含DDL語句，傳回值：

    • true：是。
    • false：否。
    DML Boolean true

    訂閱資料是否包含DML語句，傳回值：

    • true：是。
    • false：否。
    SubscriptionHost Struct

    訂閱執行個體的串連地址。
    PrivateHost String dts-cn-****-internal.aliyuncs.com:18002

    訂閱執行個體的私網串連資訊，格式為地址：連接埠號碼。
    PublicHost String dts-cn-****.aliyuncs.com:18001

    訂閱執行個體的公網串連資訊，格式為地址：連接埠號碼。
    VPCHost String dts-cn-****-vpc.aliyuncs.com:18003

    訂閱執行個體的Virtual Private Cloud（Virtual Private Cloud）串連資訊，格式為地址：連接埠號碼。
    SubscriptionInstanceID String rm-bp1162kryivb8****

    資料訂閱執行個體ID。
    SubscriptionInstanceName String mysql訂閱

    資料訂閱執行個體名稱。
    SubscriptionObject Array of SynchronousObject

    訂閱對象。
    SynchronousObject
    DatabaseName String dtstestdata

    訂閱對象所屬資料庫的名稱。
    TableList List test1

    訂閱對象的表名。
    WholeDatabase String false

    是否訂閱整庫，傳回值：

    • true：是。
    • false：否。
    Tags Array of Tag

    標籤集合。
    Tag
    Key String testkey1

    標籤鍵。
    Value String testvalue1

    標籤鍵對應的標籤值。
    Success String true

    請求是否成功。
    TotalRecordCount Long 1

    阿里雲主帳號下所有合格資料訂閱執行個體數量。

    樣本

    請求樣本

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

    正常返回樣本

    XML格式

    <DescribeSubscriptionInstancesResponse>
      <TotalRecordCount>1</TotalRecordCount>
      <PageRecordCount>30</PageRecordCount>
      <RequestId>FC3BAAF2-74E3-4471-8EB5-96202D6A****</RequestId>
      <PageNumber>1</PageNumber>
      <Success>true</Success>
      <SubscriptionInstances>
            <SubscriptionInstance>
                  <Status>Normal</Status>
                  <SubscriptionObject>
                        <SynchronousObject>
                              <DatabaseName>dtstestdata</DatabaseName>
                              <WholeDatabase>false</WholeDatabase>
                              <TableList>
                                    <Table>test1</Table>
                              </TableList>
                        </SynchronousObject>
                  </SubscriptionObject>
                  <SubscriptionDataType>
                        <DML>true</DML>
                        <DDL>true</DDL>
                  </SubscriptionDataType>
                  <SubscriptionInstanceName>mysql訂閱</SubscriptionInstanceName>
                  <SubscriptionHost>
                        <PublicHost>dts-cn-hangzhou.aliyuncs.com:18001</PublicHost>
                        <PrivateHost>dts-cn-hangzhou-internal.aliyuncs.com:18002</PrivateHost>
                        <VPCHost>dts-cn-hangzhou-vpc.aliyuncs.com:18003</VPCHost>
                  </SubscriptionHost>
                  <SubscribeTopic>cn_hangzhou_rm_bp1162kryiv******_dtstest_version2</SubscribeTopic>
                  <SourceEndpoint>
                        <InstanceID>rm-bp1162kryivb8****</InstanceID>
                        <InstanceType>RDS</InstanceType>
                  </SourceEndpoint>
                  <InstanceCreateTime>2021-06-21T10:17:21Z</InstanceCreateTime>
                  <JobCreateTime>2021-06-21T10:17:21Z</JobCreateTime>
                  <EndTimestamp>2021-06-21T10:17:21Z</EndTimestamp>
                  <PayType>PrePaid</PayType>
                  <SubscriptionInstanceID>dtsy0zz3t13h******</SubscriptionInstanceID>
                  <BeginTimestamp>2021-06-21T08:25:43Z</BeginTimestamp>
                  <Tags></Tags>
            </SubscriptionInstance>
      </SubscriptionInstances>
</DescribeSubscriptionInstancesResponse>

    JSON格式

    {
	"TotalRecordCount": 1,
	"PageRecordCount": 30,
	"RequestId": "FC3BAAF2-74E3-4471-8EB5-96202D6A****",
	"PageNumber": 1,
	"Success": true,
	"SubscriptionInstances": {
		"SubscriptionInstance": [
			{
				"Status": "Normal",
				"SubscriptionObject": {
					"SynchronousObject": [
						{
							"DatabaseName": "dtstestdata",
							"WholeDatabase": false,
							"TableList": {
								"Table": [
									"test1"
								]
							}
						}
					]
				},
				"SubscriptionDataType": {
					"DML": true,
					"DDL": true
				},
				"SubscriptionInstanceName": "mysql訂閱",
				"SubscriptionHost": {
					"PublicHost": "dts-cn-hangzhou.aliyuncs.com:18001",
					"PrivateHost": "dts-cn-hangzhou-internal.aliyuncs.com:18002",
					"VPCHost": "dts-cn-hangzhou-vpc.aliyuncs.com:18003"
				},
				"SubscribeTopic": "cn_hangzhou_rm_bp1162kryiv******_dtstest_version2",
				"SourceEndpoint": {
					"InstanceID": "rm-bp1162kryivb8****",
					"InstanceType": "RDS"
				},
				"InstanceCreateTime": "2021-06-21T10:17:21Z",
				"JobCreateTime": "2021-06-21T10:17:21Z",
                "EndTimestamp": "2021-06-21T10:17:21Z",
				"PayType": "PrePaid",
				"SubscriptionInstanceID": "dtsy0zz3t13h******",
				"BeginTimestamp": "2021-06-21T08:25:43Z",
				"Tags": {
					"Tag": []
				}
			}
		]
	}
}

    錯誤碼

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