更新时间:2023-08-16 GMT+08:00

查询Kafka实例Topic详细信息

功能介绍

查询Kafka实例Topic详细信息。(单个实例调用不要超过1s一次)

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID。

topic

String

Topic名称。

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

topic

String

topic名称。

partitions

Array of partitions objects

分区列表。

group_subscribed

Array of strings

订阅该topic的消费组名称列表。

表3 partitions

参数

参数类型

描述

partition

Integer

分区ID。

leader

Integer

leader副本所在节点的id。

leo

Integer

分区leader副本的LEO(Log End Offset)。

hw

Integer

分区高水位(HW,High Watermark)。

lso

Integer

分区leader副本的LSO(Log Start Offset)。

last_update_timestamp

Long

分区上次写入消息的时间。

格式为Unix时间戳。

单位:毫秒。

replicas

Array of replicas objects

副本列表。

表4 replicas

参数

参数类型

描述

broker

Integer

副本所在的节点ID。

leader

Boolean

该副本是否为leader。

in_sync

Boolean

该副本是否在ISR副本中。

size

Integer

该副本当前日志大小。单位:Byte。

lag

Integer

该副本当前落后hw的消息数。

请求示例

查询指定Topic的详细信息。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}

响应示例

状态码: 200

查询成功。

{
  "topic" : "test",
  "partitions" : [ {
    "partition" : 0,
    "leader" : 2,
    "replicas" : [ {
      "broker" : 2,
      "leader" : true,
      "in_sync" : true,
      "size" : 123971146,
      "lag" : 0
    }, {
      "broker" : 1,
      "leader" : false,
      "in_sync" : true,
      "size" : 123971146,
      "lag" : 0
    }, {
      "broker" : 0,
      "leader" : false,
      "in_sync" : true,
      "size" : 123971146,
      "lag" : 0
    } ],
    "lso" : 0,
    "leo" : 13598,
    "hw" : 13598,
    "last_update_timestamp" : 1571477180985
  }, {
    "partition" : 2,
    "leader" : 1,
    "replicas" : [ {
      "broker" : 1,
      "leader" : true,
      "in_sync" : true,
      "size" : 123889531,
      "lag" : 0
    }, {
      "broker" : 0,
      "leader" : false,
      "in_sync" : true,
      "size" : 123889531,
      "lag" : 0
    }, {
      "broker" : 2,
      "leader" : false,
      "in_sync" : true,
      "size" : 123889531,
      "lag" : 0
    } ],
    "lso" : 0,
    "leo" : 13601,
    "hw" : 13601,
    "last_update_timestamp" : 1571477077146
  }, {
    "partition" : 1,
    "leader" : 0,
    "replicas" : [ {
      "broker" : 0,
      "leader" : true,
      "in_sync" : true,
      "size" : 127245604,
      "lag" : 0
    }, {
      "broker" : 2,
      "leader" : false,
      "in_sync" : true,
      "size" : 127245604,
      "lag" : 0
    }, {
      "broker" : 1,
      "leader" : false,
      "in_sync" : true,
      "size" : 127245604,
      "lag" : 0
    } ],
    "lso" : 0,
    "leo" : 13599,
    "hw" : 13599,
    "last_update_timestamp" : 1571477172959
  } ],
  "group_subscribed" : [ "test-consumer-group" ]
}

状态码

状态码

描述

200

查询成功。

错误码

请参见错误码