You need to enable JavaScript to run this app.
导航
消息队列 RocketMQ版
  • 文档首页
    • /
  • 消息队列 RocketMQ版

DescribeGroupsDetail

最近更新时间：2024.03.06 16:49:22

首次发布时间：2023.07.12 16:22:34

我的收藏

调用 DescribeGroupsDetail 接口查看指定 Group 的详细信息。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

使用说明

DescribeGroupsDetail 用于查看指定 Group 的详细信息，包括消费组状态、消费模式等。

请求参数

参数

参数类型

是否必选

示例值

说明

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 适用的协议。取值说明如下：

  • TCP：表示 Group ID 仅适用于TCP 协议的消息收发。

IsSubSame

Boolean

true

Group 内消费者实例群组的订阅关系是否一致。

  • true：一致
  • false：不一致

MessageDelayTime

String

0

消息延迟时间，消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。

MessageModel

String

Clustering

消息消费模式。默认为集群模式，您也可以在 Consumer 客户端中指定消费模式为广播模式。
请勿在同一 Group 下同时配置集群模式和广播模式。

  • Clustering：集群消费模式
  • Broadcasting：广播消费模式

Status

String

Online

消费组状态。

  • Online：消费中
  • Offline：未消费

TotalConsumedRate

String

827.05

该 Group 下消费者实例群组接收消息的总 TPS，单位为条/秒。

TotalDiff

Integer

0

消费者实例群组的未消费消息的总量。
此处显示的消息堆积量为未过滤 Tag 的总堆积量，包括 Topic 下所有 Tag 的消息。

示例

请求示例

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
    }
}