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

查询消费组信息

功能介绍

查询消费组信息。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

group

是

String

参数解释：

消费组名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

group

group object

参数解释：

消费组信息。
表3 group

参数

参数类型

描述

group_id

String

参数解释：

消费组名称。

取值范围：

不涉及。

state

String

参数解释：

消费组状态。

取值范围：

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

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

  • PreparingRebalance：准备开启rebalance。

  • CompletingRebalance：所有成员加入group。

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

coordinator_id

Integer

参数解释：

协调器编号。

取值范围：

不涉及。

members

Array of members objects

参数解释：

消费者列表。

group_message_offsets

Array of group_message_offsets objects

参数解释：

消费进度。

assignment_strategy

String

参数解释：

分区分配策略。

取值范围：

不涉及。
表4 members

参数

参数类型

描述

host

String

参数解释：

消费组consumer地址。

取值范围：

不涉及。

assignment

Array of assignment objects

参数解释：

consumer分配到的分区信息。

member_id

String

参数解释：

消费组consumer的ID。

取值范围：

不涉及。

client_id

String

参数解释：

客户端ID。

取值范围：

不涉及。
表5 assignment

参数

参数类型

描述

topic

String

参数解释：

Topic名称。

取值范围：

不涉及。

partitions

Array of integers

参数解释：

分区列表。
表6 group_message_offsets

参数

参数类型

描述

partition

Integer

参数解释：

分区编号。

取值范围：

不涉及。

lag

Long

参数解释：

剩余可消费消息数，即消息堆积数。

取值范围：

不涉及。

topic

String

参数解释：

Topic名称。

取值范围：

不涉及。

message_current_offset

Long

参数解释：

当前消费进度。

取值范围：

不涉及。

message_log_end_offset

Long

参数解释：

最大消息位置（LEO）。

取值范围：

不涉及。

请求示例

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

响应示例

状态码：200

查询实例集群的消费组信息成功。

{
  "group" : {
    "members" : [ {
      "host" : "/172.xx.xx.102",
      "assignment" : [ {
        "topic" : "test",
        "partitions" : [ 0, 1, 2 ]
      } ],
      "member_id" : "consumer-1-6b8ee551-d499-47d4-9beb-ba1527496785",
      "client_id" : "consumer-1"
    } ],
    "state" : "STABLE",
    "group_id" : "test-consumer-group",
    "coordinator_id" : 2,
    "group_message_offsets" : [ {
      "partition" : 0,
      "lag" : 31396,
      "topic" : "test",
      "message_current_offset" : 935,
      "message_log_end_offset" : 32331
    }, {
      "partition" : 0,
      "lag" : 0,
      "topic" : "aaaa",
      "message_current_offset" : 0,
      "message_log_end_offset" : 0
    }, {
      "partition" : 1,
      "lag" : 31279,
      "topic" : "test",
      "message_current_offset" : 1058,
      "message_log_end_offset" : 32337
    }, {
      "partition" : 1,
      "lag" : 0,
      "topic" : "aaaa",
      "message_current_offset" : 0,
      "message_log_end_offset" : 0
    }, {
      "partition" : 2,
      "lag" : 31603,
      "topic" : "test",
      "message_current_offset" : 739,
      "message_log_end_offset" : 32342
    } ],
    "assignment_strategy" : "range"
  }
}

状态码

状态码

描述

200

查询实例集群的消费组信息成功。

错误码

请参见错误码。

父主题： 消费组管理