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

查询主题消费组列表

功能介绍

查询主题消费组列表。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

topic

是

String

参数解释:

主题名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

查询返回消费组的个数。

约束限制:

不涉及。

取值范围:

1~50。

默认取值:

10。

offset

否

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

0。

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

groups

Array of strings

参数解释:

消费组列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

total

Integer

参数解释:

Topic总数。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

查询指定主题的消费组列表。

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

响应示例

状态码:200

查询主题消费组列表成功。

{
  "total" : 2,
  "groups" : [ "CID_JODIE_1", "test_consumer" ]
}

状态码

状态码

描述

200

查询主题消费组列表成功。

错误码

请参见错误码。