文档首页/ 分布式消息服务Kafka版/ API参考(巴黎区域)/ API V2（推荐）/ 主题管理/ Kafka实例查询Topic
更新时间：2026-01-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

Kafka实例查询Topic

功能介绍

该接口用于查询指定Kafka实例的Topic详情。

URI

GET /v2/{project_id}/instances/{instance_id}/topics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

String

偏移量，表示从此偏移量开始查询， offset大于等于0。

limit

否

String

当次查询返回的最大实例个数，默认值为10，取值范围为1~50。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

topic总数。

size

Integer

分页查询的大小。

remain_partitions

Integer

剩余分区数。

max_partitions

Integer

分区总数。

topic_max_partitions

Integer

单个topic最大占用分区数。

topics

Array of TopicEntity objects

topic列表。
表4 TopicEntity

参数

参数类型

描述

policiesOnly

Boolean

是否为默认策略。

name

String

topic名称。

replication

Integer

副本数，配置数据的可靠性。

partition

Integer

topic分区数，设置消费的并发数。

retention_time

Integer

消息老化时间。

sync_replication

Boolean

是否开启同步复制，开启后，客户端生产消息时相应的也要设置acks=-1，否则不生效，默认关闭。

sync_message_flush

Boolean

是否使用同步落盘。默认值为false。同步落盘会导致性能降低。

external_configs

Object

扩展配置。

topic_type

Integer

topic类型(0:普通Topic 1:系统(内部)Topic)。

topic_other_configs

Array of topic_other_configs objects

topic其他配置

topic_desc

String

topic描述

created_at

Long

topic创建时间
表5 topic_other_configs

参数

参数类型

描述

name

String

配置名称

valid_values

String

配置有效值

default_value

String

配置默认值

config_type

String

配置类型：dynamic/static

value

String

配置值

value_type

String

配置值类型

请求示例

查询Topic列表。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics?offset=0&limit=10

响应示例

状态码： 200

查询成功。

{
  "total" : 1,
  "size" : 0,
  "topics" : [ {
    "policiesOnly" : false,
    "name" : "Topic-test01",
    "replication" : 3,
    "partition" : 3,
    "retention_time" : 72,
    "sync_replication" : "false",
    "sync_message_flush" : "false",
    "topic_other_configs" : [ {
      "name" : "max.message.bytes",
      "valid_values" : "[0...10485760]",
      "default_value" : "10485760",
      "config_type" : "dynamic",
      "value" : "10485760",
      "value_type" : "int"
    }, {
      "name" : "message.timestamp.type",
      "valid_values" : "[CreateTime, LogAppendTime]",
      "default_value" : "LogAppendTime",
      "config_type" : "dynamic",
      "value" : "LogAppendTime",
      "value_type" : "string"
    } ],
    "external_configs" : { },
    "topic_type" : 0,
    "topic_desc" : "This is a test topic",
    "created_at" : 1688112779916
  } ],
  "remain_partitions" : 294,
  "max_partitions" : 300,
  "topic_max_partitions" : 200
}

状态码

状态码

描述

200

查询成功。

错误码

请参见错误码。

父主题： 主题管理