文档首页/ 分布式消息服务Kafka版/ API参考(巴黎区域)/ API V2（推荐）/ 实例管理/ 查询所有消费组
更新时间：2023-08-16 GMT+08:00
查看PDF
分享

查询所有消费组

功能介绍

查询所有消费组。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

String

偏移量，表示从此偏移量开始查询， offset大于等于0。

limit

否

String

当次查询返回的最大消费组ID个数，默认值为10，取值范围为1~50。

group

否

String

消费组名过滤查询，过滤方式为字段包含过滤。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

groups

Array of GroupInfoSimple objects

所有的消费组。

total

Integer

所有的消费组总数。
表4 GroupInfoSimple

参数

参数类型

描述

group_id

String

消费组ID。

state

String

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

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

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

  • PreparingRebalance：准备开启rebalance。

  • CompletingRebalance：所有成员加入group。

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

coordinator_id

Integer

协调器编号。

请求示例

查询消费组列表。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups?offest={offest}&limit={limit}&group={group}

响应示例

状态码： 200

查询实例集群的所有消费组成功。

{
  "groups" : [ {
    "group_id" : "consumer-1",
    "state" : "EMPTY",
    "coordinator_id" : 1
  }, {
    "group_id" : "consumer-2",
    "state" : "STABLE",
    "coordinator_id" : 2
  }, {
    "group_id" : "consumer-3",
    "state" : "STABLE",
    "coordinator_id" : 3
  } ],
  "total" : 3
}

状态码

状态码

描述

200

查询实例集群的所有消费组成功。

错误码

请参见错误码。

父主题： 实例管理