1. 接口描述
接口请求域名: tdmq.tencentcloudapi.com 。
查询指定环境和主题下的订阅者列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSubscriptions。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
EnvironmentId | 是 | String | 环境(命名空间)名称。 示例值:test1 |
TopicName | 是 | String | 主题名称。 示例值:test |
ClusterId | 是 | String | Pulsar 集群的ID 示例值:pulsar-xxxx |
Offset | 否 | Integer | 起始下标,不填默认为0。 示例值:0 |
Limit | 否 | Integer | 返回数量,不填则默认为10,最大值为20。 示例值:10 |
SubscriptionName | 否 | String | 订阅者名称,模糊匹配。 示例值:test |
Filters.N | 否 | Array of FilterSubscription | 数据过滤条件。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SubscriptionSets | Array of Subscription | 订阅者集合数组。 |
TotalCount | Integer | 数量。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 消费订阅列表
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSubscriptions
<公共请求参数>
{
"EnvironmentId": "abc",
"TopicName": "abc",
"Offset": 1,
"Limit": 1,
"SubscriptionName": "abc",
"Filters": [
{
"ConsumerHasCount": true,
"ConsumerHasBacklog": true,
"ConsumerHasExpired": true,
"SubscriptionNames": [
"abc"
]
}
],
"ClusterId": "abc"
}
输出示例
{
"Response": {
"TotalCount": 1,
"SubscriptionSets": [
{
"EnvironmentId": "test1",
"TopicName": "test",
"ConnectedSince": "",
"ConsumerAddr": "",
"ConsumerCount": "6",
"ConsumerName": "",
"MsgBacklog": "1087",
"MsgRateExpired": "0.0",
"MsgRateOut": "0.0",
"SubType": "abc",
"MsgThroughputOut": "0.0",
"SubscriptionName": "test",
"BlockedSubscriptionOnUnackedMsgs": true,
"MaxUnackedMsgNum": 0,
"Remark": "",
"CreateTime": "2020-09-18 14:32:41",
"UpdateTime": "2021-01-13 15:23:35",
"IsOnline": true,
"ConsumerSets": [
{
"ConnectedSince": "2021-01-13T15:19:21.03+08:00",
"ConsumerAddr": "/9.219.234.200:9056",
"ConsumerName": "axjoy",
"ClientVersion": ""
},
{
"ConnectedSince": "2021-01-13T15:22:20.197+08:00",
"ConsumerAddr": "/9.219.234.202:6374",
"ConsumerName": "dkhtb",
"ClientVersion": ""
},
{
"ConnectedSince": "2021-01-13T15:22:50.282+08:00",
"ConsumerAddr": "/9.219.237.139:57322",
"ConsumerName": "ejbij",
"ClientVersion": ""
},
{
"ConnectedSince": "2021-01-13T15:18:50.927+08:00",
"ConsumerAddr": "/9.219.233.137:62564",
"ConsumerName": "hijsf",
"ClientVersion": ""
},
{
"ConnectedSince": "2021-01-13T15:21:50.227+08:00",
"ConsumerAddr": "/9.219.234.202:11554",
"ConsumerName": "nbcra",
"ClientVersion": ""
},
{
"ConnectedSince": "2021-01-13T15:19:51.032+08:00",
"ConsumerAddr": "/9.219.232.202:19345",
"ConsumerName": "vjmts",
"ClientVersion": ""
}
],
"ConsumersScheduleSets": [
{
"NumberOfEntries": 4642,
"Partitions": 0,
"MsgBacklog": 1087,
"MsgRateOut": "0.0",
"MsgThroughputOut": "0.0",
"MsgRateExpired": "0.0"
}
]
}
],
"RequestId": "39ab02af-30c8-41d4-9ac4-46cb519ceac0"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | CAM鉴权不通过。 |
FailedOperation | 操作失败。 |
FailedOperation.DescribeSubscription | 查询订阅数据失败。 |
InternalError.SystemError | 系统错误。 |
InvalidParameterValue.InvalidParams | 参数值不在允许范围内。 |
MissingParameter.NeedMoreParams | 必要参数没有传递。 |
ResourceNotFound.BrokerCluster | 服务的集群不存在。 |
ResourceNotFound.Cluster | 集群不存在。 |
ResourceNotFound.Environment | 环境不存在。 |
ResourceNotFound.Topic | 主题不存在。 |