文档首页/ 分布式消息服务Kafka版/ API参考/ API V2(推荐)/ 实例管理/ 查询Kafka集群信息 - ShowKafkaCluster
更新时间:2025-11-24 GMT+08:00
分享

查询Kafka集群信息 - ShowKafkaCluster

功能介绍

查询Kafka集群信息。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

参数解释

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

cluster

cluster object

参数解释

集群信息。

表3 cluster

参数

参数类型

描述

brokers

Array of brokers objects

参数解释

broker详情。

表4 brokers

参数

参数类型

描述

health

Boolean

参数解释

是否健康。

取值范围

  • true:健康。

  • false:不健康。

host

String

参数解释

Host地址。

取值范围

不涉及。

port

Integer

参数解释

端口。

取值范围

不涉及。

broker_id

String

参数解释

节点ID。

取值范围

不涉及。

请求示例

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

响应示例

状态码:200

查询Kafka集群信息成功。

{
  "cluster" : {
    "brokers" : [ {
      "host" : "192.168.0.1",
      "port" : 9092,
      "broker_id" : 0,
      "health" : true
    }, {
      "host" : "192.168.0.2",
      "port" : 9092,
      "broker_id" : 1,
      "health" : true
    }, {
      "host" : "192.168.0.3",
      "port" : 9092,
      "broker_id" : 2,
      "health" : true
    } ]
  }
}

状态码

状态码

描述

200

查询Kafka集群信息成功。

错误码

请参见错误码

相关文档