调用 DescribeGroupsDetail 接口查看指定 Group 的详细信息。
DescribeGroupsDetail 用于查看指定 Group 的详细信息，包括消费组状态、消费模式等。
请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | DescribeGroupsDetail | 要执行的操作，取值：DescribeGroupsDetail。 |
Version | String | 是 | 2023-01-01 | API的版本，取值：2023-01-01。 |
InstanceId | String | 是 | rocketmq-cnai1f0c29ca**** | 实例 ID。 |
GroupId | String | 是 | GID_test | 待查看 Group 详情的 Group ID。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
CreateTime | String | 2022-11-29T11:13:11Z | Group 的创建时间。 |
Description | String | test | Group 的简单描述。 |
GroupId | String | GID_test | 消费组 ID。 |
GroupType | String | TCP | Group 适用的协议。取值说明如下：
|
IsSubSame | Boolean | true | Group 内消费者实例群组的订阅关系是否一致。
|
MessageDelayTime | String | 0 | 消息延迟时间，消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。 |
MessageModel | String | Clustering | 消息消费模式。默认为集群模式，您也可以在 Consumer 客户端中指定消费模式为广播模式。
|
Status | String | Online | 消费组状态。
|
TotalConsumedRate | String | 827.05 | 该 Group 下消费者实例群组接收消息的总 TPS，单位为条/秒。 |
TotalDiff | Integer | 0 | 消费者实例群组的未消费消息的总量。 |
POST /?Action=DescribeGroupsDetail&Version=2023-01-01 HTTP/1.1 Content-Type: application/json Host: rocketmq.volcengineapi.com X-Date: 20210328T100802Z Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=******** { "InstanceId": "rocketmq-cnai1f0c29c****", "GroupId": "GID_test" }
{ "ResponseMetadata": { "RequestId": "20230508201208F0C8710A3459FF4851A0", "Action": "DescribeGroupsDetail", "Version": "2023-01-01", "Service": "RocketMQ", "Region": "cn-shanghai" }, "Result": { "CreateTime": "2022-11-29T11:13:11Z", "Description": "", "GroupId": "GID_test", "GroupType": "TCP", "MessageDelayTime": "0", "MessageModel": "Clustering", "Status": "Online", "TotalConsumedRate": "827.05", "TotalDiff": 0 } }
公共错误码请参见公共错误码文档。