ListGroups--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

ListGroups

最近更新时间：2024.03.06 16:49:21首次发布时间：2021.08.30 16:57:44

调用 ListGroups 查看 Group 列表。

注意事项

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

使用说明

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

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	MQ_INST_***	实例 ID。
Offset	Integer	必选	1	列表页码。
Limit	Integer	必选	10	列表每页数据量。
SortField	String	必选	Name	列表排序方式。支持根据以下方式排序： Name：Group ID。 CreatedTime：创建时间。
SortOrder	String	必选	Acs	列表排序类型。支持设置为： Asc：升序排列。 Desc：降序排列。

响应参数

参数	参数类型	说明
Groups	Array of GroupInfo	Group 信息。详细说明请参考 GroupInfo。
Total	Integer	Group 总数。

示例

请求示例

POST https://rocketmq.volcengineapi.com/?Action=ListGroups&Version=2021-04-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK*********************/20210328/cn-beijing/rocketmq/request, SignedHeaders=x-date, Signature=*********************

{
  "InstanceId": "MQ_INST_***",
  "Offset": 0,
  "Limit": 10,
  "SortField": "Name",
  "SortOrder": "Asc"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "*********************",
    "Action": "ListGroups",
    "Version": "2021-04-01",
    "Service": "rocketmq",
    "Region": "cn-beijing"
  },
  "Result": {
        "Groups": [
            {
                "CreatedTime": 1650108787,
                "Description": "new",
                "GroupId": "GID-123",
                "InstanceId": "MQ_INST_*****",
                "Protol": "TCP",
                "Tags": []
            }
        ],
        "Total": 1
    }
}