You need to enable JavaScript to run this app.
导航
消息队列 Kafka版
  • 文档首页
    • /
  • 消息队列 Kafka版

DescribeConsumedTopics

最近更新时间：2023.03.30 19:59:26

首次发布时间：2023.03.30 19:59:26

我的收藏

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

使用说明

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

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

kafka-cnngbnntswg1****x

实例 ID。

PageNumber

Integer

是

1

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

PageSize

Integer

是

10

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

GroupId

String

是

connect-cluster

消费组 ID。

TopicName

String

否

testtopic

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

响应参数

参数

参数类型

示例值

说明

Total

Integer

1

指定消费组消费的总 Topic 数量。

Accumulation

Integer

182238602

指定消费组堆积的总消息数。

ConsumedTopicsInfo

Array of ConsumedTopicInfoObject

/

指定消费组订阅的 Topic 中，符合筛选条件的 Topic 列表。详细说明请参考数据结构中的 ConsumedTopicInfoObject 部分。

示例

请求示例

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
    }
}