1. 接口描述
接口请求域名： tdmq.tencentcloudapi.com 。
获取指定消费组下当前客户端的连接情况
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRocketMQConsumerConnections。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 集群ID 示例值：rocketmq-4k4orqgq |
| NamespaceId | 是 | String | 命名空间名称 示例值：test_namespace |
| GroupId | 是 | String | 消费组ID 示例值：test_group |
| Offset | 是 | Integer | 偏移量 示例值：0 |
| Limit | 是 | Integer | 限制数目 示例值：20 |
| SortedBy | 否 | String | 对查询结果排序，此为排序字段，目前支持Accumulative（消息堆积量） 示例值：Accumulative |
| SortOrder | 否 | String | 查询结果排序规则，ASC为升序，DESC为降序 示例值：ASC |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数目 示例值：100 |
| Connections | Array of RocketMQConsumerConnection | 在线消费者信息 |
| GroupDetail | RocketMQGroup | 订阅组信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取指定消费组下当前客户端的连接情况
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRocketMQConsumerConnections
<公共请求参数>
{
"Limit": "20",
"Offset": "0",
"ClusterId": "rocketmq-2p9vx3ax9jxg",
"NamespaceId": "test_namespace",
"GroupId": "test_group"
}输出示例
{
"Response": {
"TotalCount": 1,
"Connections": [
{
"ClientId": "9.43.174.90@18834#7187709773375173",
"ClientAddr": "9.43.174.90",
"Language": "JAVA",
"Accumulative": 300,
"Version": "V4.9.7"
}
],
"GroupDetail": {
"Name": "test_group",
"ConsumerNum": 1,
"TotalAccumulative": 300,
"ConsumptionMode": -1,
"BroadcastEnabled": false,
"ReadEnabled": true,
"RetryPartitionNum": 1,
"CreateTime": 1727075298000,
"UpdateTime": 1727075298000,
"ClientProtocol": "TCP",
"Remark": "测试消费组",
"ConsumerType": "PUSH",
"GroupType": "TCP",
"RetryMaxTimes": 16,
"InstanceId": "rocketmq-2p9vx3ax9jxg",
"Namespace": "test_namespace",
"TPS": 10
},
"RequestId": "2823b88c-bc6c-412b-a6dd-18eb9682d233"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.Cluster | 集群不存在。 |
| ResourceUnavailable | 资源不可用。 |
