Querying Instance Monitoring Dimensions

Function

This API is used to query instance monitoring dimensions.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition: Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

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

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

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

**Table 5** instance_ids
Parameter	Type	Description
name	String	Definition Instance ID. Range N/A

**Table 6** nodes
Parameter	Type	Description
name	String	Definition Node name. Range N/A
available_zone	String	Definition: AZ. Range: N/A

**Table 7** queues
Parameter	Type	Description
name	String	Definition Queue name. Range N/A
vhost	String	Definition: Corresponding virtual host. Range: N/A

**Table 8** vhosts
Parameter	Type	Description
name	String	Definition: Virtual host name. Range: N/A

**Table 9** exchanges
Parameter	Type	Description
name	String	Definition: Exchange name. Range: N/A
vhost	String	Definition: Corresponding virtual host. Range: N/A

**Table 10** groups
Parameter	Type	Description
name	String	Definition Consumer group name. Range N/A

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" : [ ]
}