DescribeGroups - 获取实例Group列表--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

DescribeGroups - 获取实例Group列表

最近更新时间：2024.11.18 10:27:31首次发布时间：2023.07.12 16:22:34

调用 DescribeGroups 查看 Group 列表。

使用说明

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

注意事项

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeGroups	要执行的操作，取值：DescribeGroups。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
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 适用的协议进行筛选过滤。支持设置为： TCP：默认值，此 Group 仅适用于 TCP 协议的消息收发。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Total	Integer	1	Group 总数。
GroupsInfo	Array of Object	[ { "Description": "", "GroupId": "GID_test", "GroupType": "TCP" } ]	查询消费组的结果列表。

请求示例

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

错误码

公共错误码请参见公共错误码文档。