更新时间:2025-09-03 GMT+08:00

查询指定消费组

功能介绍

查询指定消费组。

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

参数

参数类型

描述

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地址。

member_id

String

消费组consumer的ID。

client_id

String

客户端ID。

表5 group_message_offsets

参数

参数类型

描述

partition

Integer

分区编号。

lag

Long

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

topic

String

Topic名称。

message_current_offset

Long

当前消费进度。

message_log_end_offset

Long

最大消息位置(LEO)。

请求示例

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

响应示例

状态码:200

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

{
  "group" : {
    "members" : [ {
      "host" : "/172.xx.xx.102",
      "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

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

错误码

请参见错误码