查询指定消费组信息 - ShowGroup

功能介绍

查询指定消费组信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。
instance_id	是	String	实例ID。
group	是	String	消费组ID。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
[数组元素]	Array of ShowGroupResp objects	查询成功。

表3 ShowGroupResp
参数	参数类型	描述
group	Array of ShowGroupEntity objects	消费组信息。

表4 ShowGroupEntity
参数	参数类型	描述
group_id	String	消费组的名称。
state	String	消费组状态。包含以下状态： Dead：消费组内没有任何成员，且没有任何元数据。 Empty：消费组内没有任何成员，存在元数据。 PreparingRebalance：准备开启rebalance。 CompletingRebalance：所有成员加入group。 Stable：消费组内成员可正常消费。
coordinator_id	Integer	协调器编号。
members	Array of MemberEntity objects	消费者列表。
group_message_offsets	Array of GroupMessageOffsetsEntity objects	消费进度。
assignment_strategy	String	分区分配策略。

表5 MemberEntity
参数	参数类型	描述
host	String	消费组consumer地址。
assignment	Array of AssignmentEntity objects	consumer分配到的分区信息。
member_id	String	消费组consumer的ID。
client_id	String	客户端ID。

表6 AssignmentEntity
参数	参数类型	描述
topic	String	Topic名称。
partitions	Array of integers	分区列表。

表7 GroupMessageOffsetsEntity
参数	参数类型	描述
partition	Integer	分区编号。
lag	Integer	剩余可消费消息数，即消息堆积数。
topic	String	Topic名称。
message_current_offset	Integer	当前消费进度。
message_log_end_offset	Integer	最大消息位置（LEO）。

请求示例

无

响应示例

状态码：200

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

{
  "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"
  }
}