更新时间:2025-12-24 GMT+08:00

查询所有消费组

功能介绍

查询所有消费组。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

String

参数解释:

偏移量。

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

不涉及。

limit

否

String

参数解释:

当次查询返回的最大消费组ID个数。

约束限制:

不涉及。

取值范围:

1~50。

默认取值:

10。

group

否

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

无

响应参数

状态码: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/{project_id}/instances/{instance_id}/groups?offset={offset}&limit={limit}&group={group}

响应示例

状态码: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

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

错误码

请参见错误码。