更新时间:2024-04-08 GMT+08:00

查询消费组列表

功能介绍

查询消费组列表。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

group

String

消费组名称。

limit

Integer

查询数量。

缺省值:10

offset

Integer

偏移量,表示从此偏移量开始查询, offset大于等于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

是否可以消费。

broadcast

Boolean

是否广播。

brokers

Array of strings

关联的代理列表。

name

String

消费组名称,只能由英文字母、数字、百分号、竖线、中划线、下划线组成,长度3~64个字符。

group_desc

String

消费组描述,长度0~200个字符。

最小长度:0

最大长度:200

retry_max_time

Integer

最大重试次数,取值范围为1~16。

createdAt

Long

创建时间戳。

permissions

Array of strings

权限集。

consume_orderly

Boolean

是否按序消费。

请求示例

查询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" ],
        "createdAt" : 1709087952686,
        "permissions" : [ ],
        "retry_max_time" : 16,
        "consume_orderly" : false
      } ],
      "max" : 4000,
      "remaining" : 3999,
      "next_offset" : -1,
      "previous_offset" : -1
    }

状态码

状态码

描述

200

查询消费组成功。

错误码

请参见错误码