文档首页/ 分布式消息服务Kafka版/ API参考（联盟区域）/ API V2（推荐）/ 消费组管理/ 查询指定消费组的Topic
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询指定消费组的Topic

功能介绍

查询指定消费组的Topic。

URI

GET /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group}/topics

表1 路径参数

参数

是否必选

参数类型

描述

engine

是

String

引擎。

project_id

是

String

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

instance_id

是

String

实例ID。

group

是

String

消费组ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询，offset大于等于0。

limit

否

Integer

当次查询返回的最大Topic个数，默认值为10，取值范围为1~50。

sort_key

否

String

排序规则：

  • topic：按Topic名称排序。

  • partition：按分区数排序。

  • messages：按消息数量排序，默认方式。

sort_dir

否

String

排序方式。

  • asc：升序。

  • desc：降序，默认方式。

topic

否

String

Topic名称。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

topics

Array of GroupTopicEntity objects

消费组Topic

total

Integer

统计数量
表4 GroupTopicEntity

参数

参数类型

描述

topic

String

Topic名称

partitions

Integer

分区

lag

Integer

消息堆积数量

请求示例

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

响应示例

状态码：200

查询成功。

{
  "topics" : [ {
    "topic" : "topic-1",
    "partitions" : 1,
    "lag" : 0
  }, {
    "topic" : "topic-2",
    "partitions" : 2,
    "lag" : 10
  } ],
  "total" : 2
}

状态码

状态码

描述

200

查询成功。

错误码

请参见错误码。

父主题： 消费组管理