文档首页/ 分布式消息服务Kafka版/ API参考（吉隆坡区域）/ API V2（推荐）/ 其他接口/ 查询实例在CES的监控层级关系
更新时间：2025-09-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例在CES的监控层级关系

功能介绍

查询实例在CES的监控层级关系。

URI

GET /v2/{project_id}/instances/{instance_id}/ces-hierarchy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

dimensions

Array of dimensions objects

参数解释：

监控维度。

instance_ids

Array of instance_ids objects

参数解释：

实例信息。

nodes

Array of nodes objects

参数解释：

节点信息。

queues

Array of queues objects

参数解释：

队列信息。

groups

Array of groups objects

参数解释：

消费组信息。
表3 dimensions

参数

参数类型

描述

name

String

参数解释：

监控维度名称。

取值范围：

不涉及。

metrics

Array of strings

参数解释：

监控指标名称。

key_name

Array of strings

参数解释：

监控查询使用的key。

dim_router

Array of strings

参数解释：

监控维度路由。

children

Array of children objects

参数解释：

子维度列表。
表4 children

参数

参数类型

描述

name

String

参数解释：

子维度名称。

取值范围：

不涉及。

metrics

Array of strings

参数解释：

监控指标名称列表。

取值范围：

不涉及。

key_name

Array of strings

参数解释：

监控查询使用的key。

dim_router

Array of strings

参数解释：

监控维度路由。
表5 instance_ids

参数

参数类型

描述

name

String

参数解释：

实例ID。

取值范围：

不涉及。
表6 nodes

参数

参数类型

描述

name

String

参数解释：

节点名称。

取值范围：

不涉及。
表7 queues

参数

参数类型

描述

name

String

参数解释：

Topic名称。

取值范围：

不涉及。

partitions

Array of partitions objects

参数解释：

分区列表。
表8 partitions

参数

参数类型

描述

name

String

参数解释：

分区名称。

取值范围：

不涉及。
表9 groups

参数

参数类型

描述

name

String

参数解释：

消费组名称。

取值范围：

不涉及。

queues

Array of queues objects

参数解释：

Topic信息。
表10 queues

参数

参数类型

描述

name

String

参数解释：

Topic名称。

取值范围：

不涉及。

partitions

Array of partitions objects

参数解释：

分区信息。
表11 partitions

参数

参数类型

描述

name

String

参数解释：

分区名称。

取值范围：

不涉及。

请求示例

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/ces-hierarchy

响应示例

状态码：200

查询成功。

{
  "dimensions" : [ {
    "name" : "kafka_instance_id",
    "metrics" : [ "current_partitions", "current_topics", "group_messages" ],
    "key_name" : [ "instance_ids" ],
    "dim_router" : [ "kafka_instance_id" ]
  }, {
    "name" : "kafka_broker",
    "metrics" : [ "broker_data_size", "broker_messages_in_rate", "broker_bytes_out_rate", "broker_bytes_in_rate", "broker_produce_mean", "broker_fetch_mean" ],
    "key_name" : [ "nodes" ],
    "dim_router" : [ "kafka_instance_id", "kafka_broker" ]
  }, {
    "name" : "kafka_rest",
    "metrics" : [ "rest_produce_success", "rest_produce_failed", "rest_produce_latency", "rest_produce_msg_num", "rest_produce_flow", "rest_consume_success", "rest_consume_failed", "rest_consume_latency", "rest_consume_msg_num", "rest_consume_flow", "rest_commit_success", "rest_commit_failed", "rest_commit_latency", "rest_commit_msg_num", "rest_commit_flow" ],
    "key_name" : [ "nodes" ],
    "dim_router" : [ "kafka_instance_id", "kafka_rest" ]
  }, {
    "name" : "kafka_topics",
    "metrics" : [ "topic_data_size", "topic_messages_in_rate", "topic_bytes_out_rate", "topic_bytes_in_rate", "topic_messages" ],
    "key_name" : [ "queues" ],
    "dim_router" : [ "kafka_instance_id", "kafka_topics" ],
    "children" : [ {
      "name" : "kafka_partitions",
      "metrics" : [ "produced_messages", "partition_messages" ],
      "key_name" : [ "queues", "partitions" ],
      "dim_router" : [ "kafka_instance_id", "kafka_topics", "kafka_partitions" ]
    } ]
  }, {
    "name" : "kafka_groups_partitions",
    "metrics" : [ "messages_consumed", "messages_remained" ],
    "key_name" : [ "groups", "queues", "partitions" ],
    "dim_router" : [ "kafka_instance_id", "kafka_groups", "kafka_groups_topics", "kafka_groups_partitions" ]
  } ],
  "instance_ids" : [ {
    "name" : "68f3f6a0-3741-453b-bda9-a6ff6b5bb6f7"
  } ],
  "nodes" : [ {
    "name" : "broker-0"
  }, {
    "name" : "broker-1"
  }, {
    "name" : "broker-2"
  } ],
  "queues" : [ {
    "name" : "aaaa",
    "partitions" : [ {
      "name" : "0"
    } ]
  }, {
    "name" : "mytest",
    "partitions" : [ {
      "name" : "0"
    }, {
      "name" : "1"
    }, {
      "name" : "2"
    } ]
  }, {
    "name" : "topic-84234378",
    "partitions" : [ {
      "name" : "0"
    }, {
      "name" : "1"
    }, {
      "name" : "2"
    } ]
  } ],
  "groups" : [ {
    "name" : "test-consumer-group",
    "queues" : [ {
      "name" : "mytest",
      "partitions" : [ {
        "name" : "0"
      }, {
        "name" : "1"
      }, {
        "name" : "2"
      } ]
    } ]
  } ]
}

状态码

状态码

描述

200

查询成功。

错误码

请参见错误码。

父主题： 其他接口