更新时间:2022-02-21 GMT+08:00

Kafka实例查询Topic

功能介绍

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

URI

GET /v1.0/{project_id}/instances/{instance_id}/topics

参数说明见表1

表1 参数说明

参数

类型

必选

说明

project_id

String

项目ID。

instance_id

String

实例ID

请求消息

请求参数

无。

请求示例

无。

响应消息

响应参数

参数说明见表2

表2 参数说明

参数

类型

说明

count

Integer

Topic个数。

topics

Array

Topic列表。

表3 参数说明

参数

类型

说明

id

String

Topic名称

replication

Integer

副本数,配置数据的可靠性

partition

Integer

Topic分区数,设置消费的并发数。

retention_time

Integer

消息老化时间。

sync_replication

Boolean

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

默认关闭。

sync_message_flush

Boolean

是否使用同步落盘。同步落盘会导致性能降低。

响应示例

{
 "count": 1,
 "topics": [
  {
   "id": "topic-test",
   "replication": 3,
   "partition": 4,
   "retention_time": 72,
   "sync_replication": "false",
   "sync_message_flush": "false"
  }
 ]
}

状态码

操作成功的状态码如表4所示,其他响应见状态码

表4 状态码

状态码

描述

200

查询成功。