文档首页/ 分布式消息服务Kafka版/ API参考/ 历史API/ API V1/ 实例使用类接口/ 查询消费组信息
更新时间：2024-01-30 GMT+08:00
查看PDF
分享

查询消费组信息

当前页面API为历史版本API，未来可能停止维护。请使用查询消费组信息。

URI

GET /v1.0/{project_id}/instances/{instance_id}/manage/groups/{group}

参数说明如下表所示。

表1 参数说明

参数

类型

必选

说明

project_id

String

是

项目ID。

instance_id

String

是

实例ID。

group

String

是

消费组名称。

请求消息

请求参数

无

请求示例

无

响应消息

响应参数

参数说明见表2。

表2 响应参数说明

参数

类型

说明

group_id

String

消费组名称。

state

String

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

  • Dead：消费组内没有任何成员，且没有任何元数据。
  • Empty：消费组内没有任何成员，存在元数据。
  • PreparingRebalance：准备开启rebalance。
  • CompletingRebalance：所有成员加入group。
  • Stable：消费组内成员可正常消费。

coordinator_id

Integer

协调器编号

members

Array of object members

消费者列表。参数参见表3。

group_message_offsets

Array of group_offsets

消费进度。参数参见表4。

assignment_strategy

String

分区分配策略。
表3 members参数说明

参数

类型

说明

host

String

消费组consumer地址。

assignment

Array of object assignment

consumer分配到的分区信息。参数请参见表5。

member_id

String

消费组consumer的ID。

client_id

String

客户端ID。
表4 group_message_offsets参数说明

参数

类型

说明

topic

String

topic名称。

partition

Integer

分区编号。

message_current_offset

Long

当前消费进度。

message_log_end_offset

Long

最大消息位置（LEO）。

lag

Long

剩余可消费消息数，即消息堆积数。
表5 assignment参数说明

参数

类型

说明

topic

String

topic名称。

partitions

Array of integer

分区列表。

响应示例

{
    "group": {
        "members": [
            {
                "host": "/172.31.1.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"
    }
}
父主题： 实例使用类接口

相关文档