调用DescribeSubscriptionInstances接口查询订阅实例列表和各订阅实例详情。

调试

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

请求参数

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

系统规定参数,取值:DescribeSubscriptionInstances

Tag.N.Key String testkey1

标签的键。

说明
  • N表示传入第几个标签的键。例如:Tag.1.Key表示传入第一个标签的键;Tag.2.Key表示传入第二个标签的键。可以同时查询1~20个标签键。
  • 不允许传入空字符串。
RegionId String cn-hangzhou

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

PageSize Integer 30

每页记录数,取值:3050100,默认值为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个标签值。
  • 允许传入空字符串。

返回数据

名称 类型 示例值 描述
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-03-15T08:25:34Z

订阅实例保存数据范围的起始时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

ConsumptionCheckpoint String 2021-03-23T07:30:31Z

订阅实例的下游消费时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

ConsumptionClient String 114.xxx.xxx.xx:dtsxxxxxxxx

下游链接对应的IP和随机标识信息,其中IP为下游客户端的IP地址,随机标示为DTS生成的随机ID。

EndTimestamp String 2021-03-26T14:03:21Z

订阅实例保存数据范围的末尾时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

ErrorMessage String xxxxxxxx

数据订阅异常的错误提示。

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

订阅实例的专有网络VPC(Virtual Private Cloud)连接信息,格式为地址:端口号

SubscriptionInstanceID String rm-bp1162kryivb8****

数据订阅实例ID。

SubscriptionInstanceName String api测试

数据订阅实例名称。

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>api测试</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_bp1162kryivb8****_dtstest_version2</SubscribeTopic>
                  <SourceEndpoint>
                        <InstanceID>rm-bp1162kryivb8****</InstanceID>
                        <InstanceType>RDS</InstanceType>
                  </SourceEndpoint>
                  <EndTimestamp>2021-03-26T14:03:21Z</EndTimestamp>
                  <PayType>PrePaid</PayType>
                  <SubscriptionInstanceID>dtsy0zz3t13h7dnbd0</SubscriptionInstanceID>
                  <BeginTimestamp>2021-03-15T08:25:34Z</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": "api测试",
				"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_bp1162kryivb8o9w6_dtstest_version2",
				"SourceEndpoint": {
					"InstanceID": "rm-bp1162kryivb8****",
					"InstanceType": "RDS"
				},
				"EndTimestamp": "2021-03-26T14:03:21Z",
				"PayType": "PrePaid",
				"SubscriptionInstanceID": "dtsy0zz3t13h7dnbd0",
				"BeginTimestamp": "2021-03-15T08:25:34Z",
				"Tags": {
					"Tag": []
				}
			}
		]
	}
}

错误码

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