- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- 开发指南
- API参考
- SDK参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询所有消费组
功能介绍
查询所有消费组。
调用方法
请参见如何调用API。
URI
GET /v2/{engine}/{project_id}/instances/{instance_id}/groups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
engine |
是 |
String |
引擎。 |
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询,offset大于等于0。 |
limit |
否 |
Integer |
当次查询返回的最大消费组ID个数,默认值为10,取值范围为1~50。 |
group |
否 |
String |
消费组名过滤查询,过滤方式为字段包含过滤。 |
topic |
否 |
String |
若指定topic,则只查询该topic的消费组。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Number |
消费组总数。 |
groups |
Array of ConsumerGroup objects |
消费组列表。 |
max |
Integer |
最大可创建消费组数量。 |
remaining |
Integer |
剩余可创建消费组数量。 |
next_offset |
Integer |
下个分页的offset。 |
previous_offset |
Integer |
上个分页的offset。 |
参数 |
参数类型 |
描述 |
---|---|---|
enabled |
Boolean |
是否可以消费。 |
broadcast |
Boolean |
是否广播。 |
brokers |
Array of strings |
关联的代理列表。 |
name |
String |
消费组名称,只能由英文字母、数字、百分号、竖线、中划线、下划线组成,长度3~64个字符。 |
group_desc |
String |
消费组描述,长度0~200个字符。 |
retry_max_time |
Integer |
最大重试次数,取值范围为1~16。 |
createdAt |
Long |
创建时间戳。 |
permissions |
Array of strings |
权限集。 |
consume_orderly |
Boolean |
是否按顺序消费。 |
请求示例
GET https://{endpoint}/v2/{engine}/{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 |
查询成功。 |
错误码
请参见错误码。