更新时间:2026-04-03 GMT+08:00

查询消费组列表

功能介绍

查询消费组列表。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

group

否

String

参数解释:

消费组名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

limit

否

Integer

参数解释:

查询数量。

约束限制:

不涉及。

取值范围:

1~50。

默认取值:

10。

offset

否

Integer

参数解释:

偏移量,表示从此偏移量开始查询。

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

0。

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Number

参数解释:

消费组总数。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

groups

Array of ConsumerGroup objects

参数解释:

消费组列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

max

Integer

参数解释:

最大可创建消费组数量。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

remaining

Integer

参数解释:

剩余可创建消费组数量。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

next_offset

Integer

参数解释:

下个分页的offset。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

previous_offset

Integer

参数解释:

上个分页的offset。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 ConsumerGroup

参数

参数类型

描述

enabled

Boolean

参数解释:

是否可以消费。

约束限制:

不涉及。

取值范围:

  • true:可以消费。

  • false:不可以消费。

默认取值:

不涉及。

broadcast

Boolean

参数解释:

是否广播。

约束限制:

不涉及。

取值范围:

  • true:可以广播。

  • false:不可以广播。

默认取值:

不涉及。

brokers

Array of strings

参数解释:

关联的代理列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

name

String

参数解释:

消费组名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

group_desc

String

参数解释:

消费组描述。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

retry_max_time

Integer

参数解释:

最大重试次数。

约束限制:

不涉及。

取值范围:

1~16。

默认取值:

不涉及。

created_at

Long

参数解释:

创建时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

permissions

Array of strings

参数解释:

权限集。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

consume_orderly

Boolean

参数解释:

是否按顺序消费。

约束限制:

不涉及。

取值范围:

  • true:顺序消费。

  • false:不按顺序消费。

默认取值:

不涉及。

group_online

Boolean

参数解释:

消费组是否在线。

约束限制:

不涉及。

取值范围:

  • true:消费组在线。

  • false:消费组不在线。

默认取值:

不涉及。

topic_subscription_count

Long

参数解释:

Topic订阅数量。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

查询RocketMQ实例的消费组列表。

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

响应示例

状态码:200

查询消费组成功。

{
  "total" : 1,
  "groups" : [ {
    "name" : "group-1",
    "enabled" : true,
    "broadcast" : false,
    "brokers" : [ "broker-0" ],
    "permissions" : [ ],
    "retry_max_time" : 16,
    "consume_orderly" : false,
    "group_online" : false,
    "group_desc" : "test",
    "created_at" : 1709087952686
  } ],
  "max" : 4000,
  "remaining" : 3999,
  "next_offset" : -1,
  "previous_offset" : -1
}

状态码

状态码

描述

200

查询消费组成功。

错误码

请参见错误码。