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

DescribeGroups

最近更新时间：2024.03.07 20:25:47

首次发布时间：2023.03.30 19:59:26

我的收藏

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

使用说明

此接口用于获取指定实例的消费组列表，支持根据消费组 ID 和状态进行筛选。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

kafka-cnngbnntswg1****x

实例 ID。

PageNumber

Integer

是

1

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

PageSize

Integer

是

10

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

GroupId

String

否

connect-cluster

根据消费组 ID 筛选。

TagFilters

Array of TagFilterObject

否

[{"Key":"keyA","Value":"valueA"}]

用于筛选 Group 的标签。

  • 标签键（Key）必填，标签值（Value）选填。标签值为空，则只根据标签建筛选 Topic。
  • 设置多个标签时，不同筛选条件之间为或关系，即满足任一标签筛选条件则匹配成功。

响应参数

参数

参数类型

示例值

说明

Total

Integer

2

消费组总数。

GroupsInfo

Array of BasicGroupInfo

/

消费组列表。

示例

请求示例

POST /?Action=DescribeGroups&Version=2022-05-01 HTTP/1.1
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=********

{
    "InstanceId": "kafka-cnoeru***",
    "PageNumber": 1,
    "PageSize": 10,
    "TagFilters": [
        {
            "Key": "doc"
        }
    ]
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20240301184438ACFD1472129B84C4**",
        "Action": "DescribeGroups",
        "Version": "2022-05-01",
        "Service": "Kafka",
        "Region": "cn-beijing"
    },
    "Result": {
        "GroupsInfo": [
            {
                "BalanceAlgorithm": "",
                "Description": "test",
                "GroupId": "group-d",
                "ProtocolType": "",
                "State": "Empty",
                "Tags": [
                    {
                        "Key": "user",
                        "Value": "a"
                    },
                    {
                        "Key": "doc",
                        "Value": "test"
                    }
                ]
            }
        ],
        "Total": 1
    }
}