更新时间：2023-05-06 GMT+08:00
查询消费组列表
功能介绍
查询消费组列表。
URI
GET /v2/{project_id}/instances/{instance_id}/groups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
instance_id |
是 |
String |
实例ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
group |
否 |
String |
消费组名称。 |
|
limit |
否 |
Integer |
查询数量。 缺省值：10 |
|
offset |
否 |
Integer |
偏移量，表示从此偏移量开始查询， offset大于等于0。 缺省值：0 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Number |
消费组总数。 |
|
groups |
Array of ConsumerGroup objects |
消费组列表。 |
|
max |
Number |
最大可创建消费组数量。 |
|
remaining |
Number |
剩余可创建消费组数量。 |
|
next_offset |
Number |
下个分页的offset。 |
|
previous_offset |
Number |
上个分页的offset。 |
请求示例
查询消费组列表。
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups
响应示例
状态码： 200
查询消费组成功。
{
"total" : 1,
"groups" : [ {
"enabled" : true,
"broadcast" : false,
"brokers" : [ "broker-0" ],
"name" : "aaaaa",
"retry_max_time" : 16,
"from_beginning" : false
} ],
"max" : 4000,
"remaining" : 3999,
"next_offset" : -1,
"previous_offset" : -1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询消费组成功。 |
错误码
请参见错误码。
父主题： 消费组管理
