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

功能介绍

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

当前页面API为历史版本API，未来可能停止维护。请使用查询实例在CES的监控层级关系。

调用方法

请参见如何调用API。

URI

GET /v1.0/{project_id}/instances/{instance_id}/ceshierarchy

表1 路径参数
参数	是否必选	参数类型	描述
instance_id	是	String	实例ID。
project_id	是	String	项目ID，获取方式请参见获取项目ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数
参数	参数类型	描述
dimensions	Object	监控维度。
instance_ids	Array of instance_ids objects	实例信息。
nodes	Array of nodes objects	节点信息。
queues	Array of queues objects	队列信息。
groups	Array of groups objects	消费组信息。

表3 instance_ids
参数	参数类型	描述
name	String	实例ID。

表4 nodes
参数	参数类型	描述
name	String	节点名称。

表5 queues
参数	参数类型	描述
name	String	topic名称。
partitions	Array of partitions objects	分区列表。

表6 partitions
参数	参数类型	描述
name	String	分区名称。

表7 groups
参数	参数类型	描述
name	String	消费组名称。
queues	Array of queues objects	topic信息。

表8 queues
参数	参数类型	描述
name	String	topic名称。
partitions	Array of partitions objects	分区信息。

表9 partitions
参数	参数类型	描述
name	String	分区名称。

请求示例

GET https://{endpoint}/v1.0/{project_id}/instances/{instance_id}/ceshierarchy

响应示例

状态码： 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"
      } ]
    } ]
  } ]
}