1. 接口描述
接口请求域名： trocket.tencentcloudapi.com 。
查询消费组详情
默认接口请求频率限制：10000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeConsumerGroup。 |
| Version | 是 | String | 公共参数，本接口取值：2023-03-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群ID 示例值：rmq-72mo3a9o |
| ConsumerGroup | 否 | String | 消费组名称 示例值：test_group |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ConsumerNum | Integer | 在线消费者数量 示例值：1 |
| Tps | Integer | TPS 示例值：1 |
| ConsumerLag | Integer | 消息堆积数量 示例值：1 |
| ConsumeType | String | 消费者类型 示例值：PUSH |
| CreatedTime | Integer | 创建时间，秒为单位 示例值：1683613488000 |
| ConsumeMessageOrderly | Boolean | 顺序投递：true 并发投递：false 示例值：false |
| ConsumeEnable | Boolean | 是否开启消费 示例值：false |
| MaxRetryTimes | Integer | 最大重试次数 示例值：3 |
| Remark | String | 备注 示例值：测试消费组 |
| MessageModel | String | 消费模式： BROADCASTING 广播模式 CLUSTERING 集群模式 示例值：BROADCASTING |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询消费组详情
查询消费者详情
输入示例
POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConsumerGroup
<公共请求参数>
{
"InstanceId": "rmq-72mo3a9o",
"ConsumerGroup": "group"
}输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"ConsumeEnable": true,
"ConsumeMessageOrderly": false,
"ConsumeType": "PUSH",
"ConsumerLag": 1580,
"ConsumerNum": 2,
"CreatedTime": 1683613488000,
"MaxRetryTimes": 16,
"Remark": "测试消费组",
"RequestId": "bc4ffab1-65cc-4ef6-9114-0de06c333b84",
"Tps": 60
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.Group | 消费组不存在，请检查后重试。 |
| ResourceNotFound.Instance | 实例不存在。 |
