DescribeGroups--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

消息队列 Kafka版

DescribeGroups

最近更新时间：2022.10.18 16:24:27首次发布时间：2022.04.24 15:56:38

调用 DescribeGroups 接口获取消费组列表。

使用说明

此接口的 API Version 为 2018-01-01。
此接口的调用频率限制为 100 次/s，超出频率限制会报错 “AccountFlowLimitExceeded”。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	kafka-****x	实例 ID。
PageNumber	Integer	必选	1	查询消费组的页码。不小于 1。
PageSize	Integer	必选	10	查询消费组单页的个数。
FieldName	String	可选	GroupId	查询结果的排序字段，当前只支持 GroupId。
SortOrder	String	可选	Asc	排序方式，可设置为： Desc：降序 Asc：升序
Search	String	可选	group-test	根据此参数指定的 Group 名称进行筛选，支持模糊匹配。

响应参数

参数	参数类型	说明
Total	Integer	消费组总数。
Groups	List	查询消费组的结果列表。详细说明请参考 StandardGroupInfo。

示例

请求示例

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

{
  "PageNumber": 1,
  "PageSize": 10,
  "InstanceId": "kafka-****x"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "DescribeGroups",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": {
    "Total": 0,
    "Groups": [
      {
        "GroupId": "",
        "InstanceId": "",
        "State": ""
      }
    ]
  }
}