DescribeTopics--消息队列 Kafka版-火山引擎

文档中心

立即注册

导航

DescribeTopics

最近更新时间：2022.11.22 16:46:00首次发布时间：2021.08.30 16:20:22

调用 DescribeTopics 接口查看 Topic 列表。

使用说明

此接口的 API Version 为 2018-01-01。
此接口的调用频率限制为 100 次/s，超出频率限制会报错 “AccountFlowLimitExceeded”。

请求参数

参数	参数类型	是否必选	示例值	说明
InstanceId	String	必选	kafka-****	实例 ID。
PageNumber	Integer	必选	1	列表的页码，取值不小于 1。
PageSize	Integer	必选	10	单页查询的实例个数，取值范围为 1~50。
FiledName	String	可选	Name	排序使用的字段，当前只支持根据 Name 进行排序。
SortOrder	String	可选	Asc	排序方式。支持设置为： Asc：升序排列。 Desc：降序排列。
Search	String	可选	my_topic	根据 Topic 名称精确匹配。
Filters	`List<Filter>`	可选	请参考请求示例。	过滤条件。其中包括： Name：筛选的名称。目前仅支持设置为 “Name” ，即根据 Topic 名称进行筛选。 Values：筛选的值，`List<String>` 类型。

响应参数

参数	参数类型	说明
Total	Integer	符合查询条件的 Topic 总数。
Topics	List	符合查询条件的 Topic 列表。详细信息请参考 StandardTopicInfo。

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=DescribeTopics&Version=2018-01-01 HTTP/1.1
Accept: application/json
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=********

{
  "PageNumber": 1,
  "PageSize": 10,
  "InstanceId": "kafka-****",
  "FiledName": "Name",
  "SortOrder": "Asc",
  "Search": "my_topic",
  "Filters": [
    {
      "Name": "Name",
      "Values": [
        ""
      ]
    }
  ]
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "DescribeTopics",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": {
        "Topics": [
            {
                "CreateTime": "2022-04-07T21:13:34+08:00",
                "Description": "",
                "InstanceId": "kafka-******",
                "MaxMessageMegabyte": 10,
                "MinInsyncReplicaNumber": 2,
                "Name": "test-plb",
                "PartitionNumber": 12,
                "Region": "cn-beijing",
                "ReplicaNumber": 3,
                "RetentionHour": 72,
                "Status": "Running",
                "UpdateTime": "2022-04-07T21:13:35+08:00"
            }
        ],
        "Total": 1
    }
}