文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 消息集成API/ 消费组管理/ 查询所有消费组
更新时间：2024-07-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询所有消费组

功能介绍

查询所有消费组。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

实例ID。

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

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

limit

否

Integer

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

group

否

String

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

topic

否

String

若指定Topic，则只查询该Topic的消费组。

最大长度：200

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ListInstanceGroupResp objects

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

参数

参数类型

描述

groups

Array of ListGroupEntity objects

所有的消费组。

total

Integer

所有的消费组总数。
表5 ListGroupEntity

参数

参数类型

描述

createdAt

Integer

创建时间。

group_id

String

消费组ID。

state

String

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

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

coordinator_id

Integer

协调器编号。

group_desc

String

消费组描述。

lag

Integer

堆积数。

请求示例

无

响应示例

状态码： 200

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

{
  "groups" : [ {
    "createdAt" : 1691401194847,
    "group_id" : "consumer-1",
    "state" : "EMPTY",
    "coordinator_id" : 1,
    "lag" : 0,
    "group_desc" : null
  }, {
    "createdAt" : 1691401194960,
    "group_id" : "consumer-2",
    "state" : "STABLE",
    "coordinator_id" : 2,
    "lag" : 0,
    "group_desc" : null
  }, {
    "createdAt" : 1691401207309,
    "group_id" : "consumer-3",
    "state" : "STABLE",
    "coordinator_id" : 3,
    "lag" : 0,
    "group_desc" : null
  } ],
  "total" : 3
}

状态码

状态码

描述

200

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

错误码

请参见错误码。

父主题： 消费组管理

相关文档