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

DescribeGroups

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

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

我的收藏

调用 DescribeGroups 查看 Group 列表。

注意事项

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

使用说明

DescribeGroups 用于查看指定实例下的 Group 列表，其中包含每个 Group 的详细信息。如果只需查看指定 Group 的详细信息，推荐使用 DescribeGroupsDetail 接口。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

rocketmq-cnai1f0c29ca****

实例 ID。

PageNumber

Integer

是

1

列表的页码，最小值为 1。

PageSize

Integer

是

10

列表中每一页的条目数量，取值范围为 1~100。

GroupId

String

否

GID_test

根据 Group 的 ID 筛选。支持模糊查询。
不指定此参数时，表示查询所有 Group。

GroupType

String

否

TCP

按 Group ID 适用的协议进行筛选过滤。支持设置为：

  • TCP：默认值，此 Group ID 仅适用于 TCP协议的消息收发。

响应参数

参数

参数类型

示例值

说明

Total

Integer

1

Group总数。

GroupInfo

Array of BasicGroupInfo

[ { "Description": "", "GroupId": "GID_test", "GroupType": "TCP" } ]

查询消费组的结果列表。详细说明请参考BasicGroupInfo。

示例

请求示例

POST /?Action=DescribeGroups&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****",
  "PageNumber":1,
  "PageSize": 10,
  "GroupId": "GID_test",
  "GroupType": "TCP"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202305082009162F5A1402ACAAE04A1E3E",
        "Action": "DescribeGroups",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-shanghai"
    },
    "Result": {
        "GroupsInfo": [
            {
                "Description": "",
                "GroupId": "GID_test",
                "GroupType": "TCP"
            }
        ],
        "Total": 1
    }
}