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

查询Kafka集群元数据信息

功能介绍

查询Kafka集群元数据信息。

URI

GET /v2/{project_id}/instances/{instance_id}/management/cluster

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

cluster

cluster object

集群基本信息。
表3 cluster

参数

参数类型

描述

controller

String

控制器ID。

brokers

Array of brokers objects

节点列表。

topics_count

Integer

主题数量。

partitions_count

Integer

分区数量。

online_partitions_count

Integer

在线分区数量。

replicas_count

Integer

副本数量。

isr_replicas_count

Integer

ISR（In-Sync Replicas） 副本总数。

consumers_count

Integer

消费组数量。
表4 brokers

参数

参数类型

描述

host

String

节点IP。

port

Integer

端口号。

broker_id

String

节点ID。

is_controller

Boolean

是否为controller节点。

version

String

服务端版本。

register_time

Long

broker注册时间，为unix时间戳格式。

is_health

Boolean

Kafka实例节点的连通性是否正常。

请求示例

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

响应示例

状态码： 200

查询Kafka集群元数据信息成功。

{
  "cluster" : {
    "controller" : "2",
    "brokers" : [ {
      "host" : "192.168.0.159",
      "port" : 9093,
      "broker_id" : "0",
      "is_controller" : false,
      "version" : "1.1.0",
      "register_time" : 1588754647872,
      "is_health" : true
    }, {
      "host" : "192.168.0.48",
      "port" : 9093,
      "broker_id" : "1",
      "is_controller" : false,
      "version" : "1.1.0",
      "register_time" : 1588754647653,
      "is_health" : true
    }, {
      "host" : "192.168.0.212",
      "port" : 9093,
      "broker_id" : "2",
      "is_controller" : true,
      "version" : "1.1.0",
      "register_time" : 1588754647284,
      "is_health" : true
    } ],
    "topics_count" : 3,
    "partitions_count" : 9,
    "online_partitions_count" : 9,
    "replicas_count" : 27,
    "isr_replicas_count" : 27,
    "consumers_count" : 0
  }
}

状态码

状态码

描述

200

查询Kafka集群元数据信息成功。

错误码

请参见错误码。

父主题： 实例管理