文档首页/分布式消息服务Kafka版/API参考/历史API/API V2/消费组管理/查询所有消费组
更新时间：2025-11-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询所有消费组

功能介绍

查询所有消费组。

调用方法

请参见如何调用API。

URI

GET /v2/{engine}/{project_id}/instances/{instance_id}/groups

表1 路径参数

参数

是否必选

参数类型

描述

engine

是

String

引擎。

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询， offset大于等于0。

limit

否

Integer

当次查询返回的最大消费组id个数，默认值为10，取值范围为1~50。

group

否

String

消费组名过滤查询，过滤方式为字段包含过滤。

topic

否

String

若指定topic，则只查询该topic的消费组。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

groups

Array of GroupInfoSimple objects

所有的消费组。

total

Integer

所有的消费组总数。

表4 GroupInfoSimple

参数

参数类型

描述

createdAt

Long

创建时间。

group_id

String

消费组ID。

state

String

消费组状态。包含以下状态：

  • Dead：消费组内没有任何成员，且没有任何元数据。

  • Empty：消费组内没有任何成员，存在元数据。

  • PreparingRebalance：准备开启rebalance。

  • CompletingRebalance：所有成员加入group。

  • Stable：消费组内成员可正常消费。

coordinator_id

Integer

协调器编号。

group_desc

String

消费组描述。

lag

Long

堆积数。

请求示例

GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups

响应示例

状态码： 200

查询实例集群的所有消费组成功。

{
  "groups" : [ {
    "createdAt" : 1691401194847,
    "group_id" : "consumer-1",
    "state" : "EMPTY",
    "coordinator_id" : 1,
    "lag" : 0,
    "group_desc" : null
  }, {
    "createdAt" : 1691401194960,
    "group_id" : "consumer-2",
    "state" : "STABLE",
    "coordinator_id" : 2,
    "lag" : 0,
    "group_desc" : null
  }, {
    "createdAt" : 1691401207309,
    "group_id" : "consumer-3",
    "state" : "STABLE",
    "coordinator_id" : 3,
    "lag" : 0,
    "group_desc" : null
  } ],
  "total" : 3
}

状态码

状态码

描述

200

查询实例集群的所有消费组成功。

错误码

请参见错误码。

父主题： 消费组管理