You need to enable JavaScript to run this app.
导航
DescribeConsumedTopics - 查看 Group 订阅的 Topic
最近更新时间:2024.10.31 17:19:24首次发布时间:2023.03.30 19:59:26

调用 DescribeConsumedTopics 接口查看消费组订阅的 Topic 信息。

使用说明

此接口用于查看指定消费组订阅的 Topic 列表,其中包括消费组在每个 Topic 中的消费状态。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

DescribeConsumedTopics

要执行的操作,取值:DescribeConsumedTopics。

Version
String

2022-05-01

API的版本,取值:2022-05-01。

InstanceId
String

kafka-cnngbnntswg1****

实例 ID。

PageNumber
Integer

1

列表的页码,最小值为 1。

PageSize
Integer

10

列表中每一页的条目数量,取值范围为 1~100。

GroupId
String

my_group

消费组 ID。

TopicName
String

my_topic

根据 Topic 名称筛选,支持模糊搜索。
不指定此参数时默认返回指定 Group 订阅的所有 Topic。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Total
Integer

1

消费组消费的总 Topic 数量。

ConsumedTopicsInfo
Array of Object

--

消费组订阅的 Topic 中,符合筛选条件的 Topic 列表。

Accumulation
Long

1804832

消费组堆积的总消息数

请求示例

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": "202302272048242247F4CA2CB8745C6DD7",
        "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 不存在。