You need to enable JavaScript to run this app.
文档中心
消息队列 Kafka版

消息队列 Kafka版

复制全文
下载 pdf
Group 管理
DescribeConsumedTopics - 查看 Group 订阅的 Topic
复制全文
下载 pdf
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 中的消息堆积总量。​
​
​
​
请求示例​
​
POST /?Action=DescribeConsumedTopics&Version=2022-05-01 HTTP/1.1​
Content-Type: application/json​
Host: kafka.volcengineapi.com​
X-Date: 20210328T100802Z​
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/kafka/request, SignedHeaders=x-date, Signature=********​
​
{​
"InstanceId": "kafka-cnng1si21igu****",​
"PageNumber": 1,​
"PageSize": 2,​
"GroupId":"Group",​
"TopicName": "test"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202302272048242247F4CA***DD7",​
"Action": "DescribeConsumedTopics",​
"Version": "2022-05-01",​
"Service": "Kafka",​
"Region": "cn-beijing"​
},​
"Result": {​
"Accumulation": 182238602,​
"ConsumedTopicsInfo": [​
{​
"Accumulation": 182238602,​
"TopicName": "test"​
}​
],​
"Total": 1​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
The specified parameter is not valid.​
参数值无效。​
400​
InvalidParameter.GroupId​
The specified parameter GroupId is not valid.​
GroupId 无效。​
403​
OperationDenied.AccountNotAuthorized​
You are not authorized to perform this operation.​
您不具备相关权限 ,请授权或切换账号后重试。​
403​
OperationDenied.InvalidInstanceStatus​
The operation is not valid for the current status of the instance.​
当前实例状态不允许执行该操作。​
404​
InvalidInstanceId.NotFound​
The specified Instance ID does not exist.​
实例不存在。​
404​
InvalidGroupId.NotFound​
The specified consumer group does not exist.​
Group 不存在。​
​
​
最近更新时间:2026.10.29 10:50:03
这个页面对您有帮助吗?
有用
有用
无用
无用