更新时间：2025-12-08 GMT+08:00

查询Kafka实例Topic详细信息

功能介绍

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

当前页面API为历史版本API，未来可能停止维护。请使用获取Kafka Topic详细信息。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，获取方式请参见获取项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
instance_id	是	String	参数解释：实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例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。取值范围： true：该副本是leader。 false：该副本不是leader。
in_sync	Boolean	参数解释：该副本是否在ISR副本中。取值范围： true：在ISR副本中。 false：不在ISR副本中。
size	Integer	参数解释：该副本当前日志大小。单位：Byte。取值范围：不涉及
lag	Long	参数解释：该副本当前落后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	查询成功。

错误码

请参见错误码。

父主题：主题管理