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

DescribeTopics

最近更新时间：2024.04.01 17:20:47

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

我的收藏

调用 DescribeTopics 接口查看 Topic 列表。

使用说明

此接口用于查看指定实例的 Topic 列表，也可以用于查看某个 Topic 的基础信息。

请求参数

参数

参数类型

是否必选

示例值

说明

InstanceId

String

是

kafka-cnngbnntswg1****

实例 ID。

PageNumber

Integer

是

1

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

PageSize

Integer

是

10

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

TopicName

String

否

Name

Topic 名称，设置此参数表示根据指定的 Topic 名称进行筛选，支持模糊匹配。

PartitionNumber

Integer

否

10

分区个数。设置此参数表示根据指定的分区个数筛选 Topic 列表。

ReplicaNumber

Integer

否

2

Topic 副本个数。设置此参数表示根据指定的副本个数筛选 Topic 列表。

TagFilters

Array of TagFilterObject

否

[{"Key":"keyA","Value":"valueA"}]

用于筛选 Topic 的标签。

  • 标签键（Key）必填，标签值（Value）选填。标签值为空，则只根据标签建筛选 Topic。
  • 设置多个标签时，不同筛选条件之间为或关系，即满足任一标签筛选条件则匹配成功。

响应参数

参数

参数类型

示例值

说明

InstanceId

String

kafka-cnngbnntswg1****

实例 ID。

Total

Integer

1

符合查询条件的 Topic 总数。

TopicsInfo

Array of BasicTopicInfoObject

/

符合查询条件的 Topic 列表。

示例

请求示例

POST /?Action=DescribeTopics&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-cnoerum8**",
    "PageNumber": 1,
    "PageSize": 10,
    "TagFilters": [
        {
            "Key": "data"
        }
    ],
    "SortOrder": "Desc"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202404011015306A0A41F50087AA332***",
        "Action": "DescribeTopics",
        "Version": "2022-05-01",
        "Service": "kafka",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "InstanceId": "kafka-cnou8z5***",
        "TopicsInfo": [
            {
                "CleanupPolicy": [
                    "delete"
                ],
                "CreateTime": "2024-03-15T06:15:47Z",
                "Description": "",
                "LogRetentionHours": 72,
                "PartitionNumber": 12,
                "ReplicaNumber": 3,
                "Status": "Running",
                "TopicName": "topic-http",
                "UsedStoragePercentageInInstance": 0,
                "UsedStorageSpaceInBytes": 0
            },
            {
                "CleanupPolicy": [
                    "compact"
                ],
                "CreateTime": "2024-03-29T11:18:17Z",
                "Description": "",
                "LogRetentionHours": 72,
                "PartitionNumber": 12,
                "ReplicaNumber": 3,
                "Status": "Running",
                "TopicName": "topic-1",
                "UsedStoragePercentageInInstance": 0,
                "UsedStorageSpaceInBytes": 0
            }
        ],
        "Total": 2
    }
}