文档首页/ 分布式消息服务Kafka版/ API参考（联盟区域）/ API V2（推荐）/ 消费组管理/ 查询指定消费组
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询指定消费组

功能介绍

查询指定消费组。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

engine

是

String

引擎。

project_id

是

String

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

instance_id

是

String

实例ID。

group

是

String

消费组名过滤查询。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

group

group object

消费组信息。
表3 group

参数

参数类型

描述

state

String

参数解释：

消费组状态。

取值范围：

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

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

  • PreparingRebalance：准备开启rebalance。

  • CompletingRebalance：所有成员加入group。

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

createdAt

AnyType

参数解释：

创建时间。

取值范围：

不涉及。

group_id

String

参数解释：

消费组名称。

取值范围：

不涉及。

coordinator_id

Integer

参数解释：

协调器编号。

取值范围：

不涉及。

assignment_strategy

String

参数解释：

分区分配策略。

取值范围：

不涉及。

group_desc

String

参数解释：

消费组描述。

取值范围：

不涉及。

请求示例

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

响应示例

状态码：200

查询指定消费组信息成功。

{
  "group" : {
    "state" : "EMPTY",
    "createdAt" : 1765333498068,
    "group_id" : "test-consumer-group",
    "coordinator_id" : 0,
    "assignment_strategy" : "",
    "group_desc" : "wefewf"
  }
}

状态码

状态码

描述

200

查询指定消费组信息成功。

错误码

请参见错误码。

父主题： 消费组管理