文档首页/ 分布式消息服务Kafka版/ API参考（吉隆坡区域）/ API V2（推荐）/ 实例管理/ 查询Kafka集群元数据信息
更新时间：2025-09-03 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。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例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节点。

取值范围：

  • true：是controller节点。

  • false：不是controller节点。

version

String

参数解释：

服务端版本。

取值范围：

  • 1.1.0

  • 2.3.0

  • 2.7

  • 3.x

register_time

Long

参数解释：

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

取值范围：

不涉及。

is_health

Boolean

参数解释：

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

取值范围：

  • true：正常。

  • false：不正常。

请求示例

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集群元数据信息成功。

错误码

请参见错误码。

父主题： 实例管理