Updated on 2025-11-19 GMT+08:00

Querying RabbitMQ Instance Monitoring Dimensions

Function

This API is used to query RabbitMQ instance monitoring dimensions.

This API is an out-of-date version and may not be maintained in the future. Please use the API described in Querying RabbitMQ Instance Monitoring Dimensions.

Call Method

For details, see How to Call an API.

URI

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

Table 1 URI parameter

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Request

None

Response

Status code: 200

Table 2 Response body parameter

Parameter

Type

Description

dimensions

Object

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.

groups

Array of groups objects

Consumer group information.

Table 3 instance_ids

Parameter

Type

Description

name

String

Instance ID.

Table 4 nodes

Parameter

Type

Description

name

String

Node name.

Table 5 queues

Parameter

Type

Description

name

String

Topic name.

partitions

Array of partitions objects

Partition list.

Table 6 partitions

Parameter

Type

Description

name

String

Partition name.

Table 7 groups

Parameter

Type

Description

name

String

Consumer group name.

queues

Array of queues objects

Topic information.

Table 8 queues

Parameter

Type

Description

name

String

Topic name.

partitions

Array of partitions objects

Partition information

Table 9 partitions

Parameter

Type

Description

name

String

Partition name.

Example Request

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

Example Response

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" : "cn-north-7c"
  }, {
    "name" : "dms-vm-0e16280d-rabbitmq-1",
    "available_zone" : "cn-north-7c"
  }, {
    "name" : "dms-vm-0e16280d-rabbitmq-2",
    "available_zone" : "cn-north-7c"
  } ],
  "queues" : [ {
    "name" : "Vhost-17130843__Queue-21084756",
    "vhost" : "default"
  } ],
  "vhosts" : [ {
    "name" : "default"
  } ],
  "exchanges" : [ {
    "name" : "direct_exchange",
    "vhost" : "default"
  } ],
  "groups" : [ ]
}

Status Code

Status Code

Description

200

The query is successful.

Error Code

See Error Codes.