Updated on 2025-06-20 GMT+08:00

Querying RocketMQ Instance Monitoring Dimensions

Function

This API is used to query RocketMQ instance monitoring dimensions.

Call Method

For details, see How to Call an API.

URI

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

Table 1 URI parameters

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 parameters

Parameter

Type

Description

dimensions

Object

Monitoring dimensions.

instance_ids

Array of instance_ids objects

Instance information.

nodes

Array of nodes objects

Broker information.

queues

Array of queues objects

Topic 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

Broker 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/{project_id}/instances/{instance_id}/ceshierarchy

Example Response

Status code: 200

Metrics queried successfully.

{
  "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"
      } ]
    } ]
  } ]
}

Status Code

Status Code

Description

200

Metrics queried successfully.

Error Code

See Error Codes.