Querying Instance Monitoring Dimensions

Updated on 2025-03-26 GMT+08:00

View PDF

Function

This API is used to query instance monitoring dimensions.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
dimensions	Array of dimensions objects	Monitoring dimensions.
instance_ids	Array of instance_ids objects	Instance information.
nodes	Array of nodes objects	Node information.
queues	Array of queues objects	Queue information.
vhosts	Array of vhosts objects	Virtual host information.
exchanges	Array of exchanges objects	Exchange information.
groups	Array of groups objects	Consumer group information.

**Table 3** dimensions
Parameter	Type	Description
name	String	Monitoring dimension name.
metrics	Array of strings	Metric name.
key_name	Array of strings	Key used for monitoring query.
dim_router	Array of strings	Monitoring dimension route.
children	Array of children objects	List of secondary dimensions.

**Table 4** children
Parameter	Type	Description
name	String	Secondary dimension name.
metrics	Array of strings	Metrics on the secondary dimension.
key_name	Array of strings	Key used for monitoring query.
dim_router	Array of strings	Monitoring dimension route.

**Table 5** instance_ids
Parameter	Type	Description
name	String	Instance ID.

**Table 6** nodes
Parameter	Type	Description
name	String	Node name.
available_zone	String	AZ.

**Table 7** queues
Parameter	Type	Description
name	String	Queue name.
vhost	String	Corresponding virtual host.

**Table 8** vhosts
Parameter	Type	Description
name	String	Virtual host name.

**Table 9** exchanges
Parameter	Type	Description
name	String	Exchange name.
vhost	String	Corresponding virtual host.

**Table 10** groups
Parameter	Type	Description
name	String	Consumer group name.

Example Requests

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

Example Responses

Status code: 200

The query is successful.

{
  "dimensions" : [ {
    "name" : "rabbitmq_instance_id",
    "metrics" : [ "connections", "channels", "queues", "consumers", "messages_ready", "messages_unacknowledged", "publish", "deliver", "deliver_no_ack", "deliver_get", "instance_bytes_in_rate", "instance_bytes_out_rate", "instance_disk_usage" ],
    "key_name" : [ "instance_ids" ],
    "dim_router" : [ "rabbitmq_instance_id" ]
  }, {
    "name" : "rabbitmq_node",
    "metrics" : [ "fd_used", "socket_used", "proc_used", "mem_used", "disk_free", "rabbitmq_alive", "rabbitmq_disk_usage", "rabbitmq_cpu_usage", "rabbitmq_cpu_core_load", "rabbitmq_memory_usage", "rabbitmq_disk_read_await", "rabbitmq_disk_write_await", "rabbitmq_node_bytes_in_rate", "rabbitmq_node_bytes_out_rate", "rabbitmq_node_queues", "rabbitmq_memory_high_watermark", "rabbitmq_disk_insufficient" ],
    "key_name" : [ "nodes" ],
    "dim_router" : [ "rabbitmq_instance_id", "rabbitmq_node" ]
  }, {
    "name" : "rabbitmq_queue",
    "metrics" : [ "queue_messages_unacknowledged", "queue_messages_ready" ],
    "key_name" : [ "queues" ],
    "dim_router" : [ "rabbitmq_instance_id", "rabbitmq_queue" ]
  } ],
  "instance_ids" : [ {
    "name" : "0e16280d-7451-4f5b-80fa-f210372ce657"
  } ],
  "nodes" : [ {
    "name" : "dms-vm-0e16280d-rabbitmq-0",
    "available_zone" : "xx-xxx-xx"
  }, {
    "name" : "dms-vm-0e16280d-rabbitmq-1",
    "available_zone" : "xx-xxx-xx"
  }, {
    "name" : "dms-vm-0e16280d-rabbitmq-2",
    "available_zone" : "xx-xxx-xx"
  } ],
  "queues" : [ {
    "name" : "Vhost-17130843__Queue-21084756",
    "vhost" : "default"
  } ],
  "vhosts" : [ {
    "name" : "default"
  } ],
  "exchanges" : [ {
    "name" : "direct_exchange",
    "vhost" : "default"
  } ],
  "groups" : [ ]
}