- 文档首页
消息队列 Kafka版
API 参考
V2(2022-05-01)
Group 管理
DescribeConsumedTopics - 查看 Group 订阅的 Topic
Group 管理
DescribeConsumedTopics - 查看 Group 订阅的 Topic
DescribeConsumedTopics - 查看 Group 订阅的 Topic
调用 DescribeConsumedTopics 接口,查看指定消费组对应的 Topic 主题消费位点信息。
使用说明
此接口用于查看指定消费组订阅的 Topic 列表,其中包括消费组在每个 Topic 中的消费状态。
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。 Action string 必选 示例值:DescribeConsumedTopics
要执行的操作,取值:DescribeConsumedTopics。
Version string 必选 示例值:2022-05-01
API 的版本,取值:2022-05-01。
PageNumber integer 必选 示例值:1
列表的页码,最小值为 1。
PageSize integer 必选 示例值:2
列表中每一页的条目数量,取值范围为 1~100。
InstanceId string 必选 示例值:kafka-cnng1si21igu****
实例 ID。
GroupId string 必选 示例值:Group
消费组 ID。
TopicName string 可选 示例值:test
根据 Topic 名称筛选,支持模糊搜索。
不指定此参数时默认返回指定 Group 订阅的所有 Topic。
返回参数
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。 Total integer 示例值:1
消费组消费的总 Topic 数量。
Accumulation long 示例值:182238602
消费组堆积的总消息数。
ConsumedTopicsInfo object[] 示例值: { "Accumulation": 182238602, "TopicName": "test" }
消费组订阅的 Topic 中,符合筛选条件的 Topic 列表。
TopicName string 示例值:test
Topic 名称。
Accumulation long 示例值:1804832
消费组在此 Topic 中的消息堆积总量。
请求示例
返回示例
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
最近更新时间:2026.10.29 10:50:03