Viewing the Monitoring Overview

Function

This API is used to view the monitoring overview.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/{project_id}/kafka/{instance_id}/metric-dashboard

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. To obtain it, call the API for querying all instances. 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
metric_topn	InstanceMetricData object	Definition Top monitoring metric data. Range N/A
resources	InstanceMetricResources object	Definition Instance resource information Range N/A
dims_metric_topn	Array of InstanceMetricSortIterm objects	Definition Top N metric data by topic, broker, or other dimensions. Range N/A
broker_connections	InstanceBrokerConnections object	Definition Top N IP addresses with the most connections and their specific number of connections. Range N/A

**Table 3** InstanceMetricData
Parameter	Type	Description
consumer_messages_consumed	InstanceMetricSortIterm object	Definition Messages consumed by a consumer group. Range N/A
consumer_messages_remained	InstanceMetricSortIterm object	Definition Number of the accumulated messages of the consumer group. Range N/A
broker_disk_read_rate	InstanceMetricSortIterm object	Definition Disk read rate of the broker. Range N/A
topic_messages	InstanceMetricSortIterm object	Definition Number of topics. Range N/A
network_bandwidth_usage	InstanceMetricSortIterm object	Definition Network bandwidth usage of the broker. Range N/A
topic_bytes_in_rate	InstanceMetricSortIterm object	Definition Topic production rate. Range N/A
broker_cpu_usage	InstanceMetricSortIterm object	Definition CPU usage of the broker. Range N/A
topic_bytes_out_rate	InstanceMetricSortIterm object	Definition Topic consumption rate. Range N/A

**Table 4** InstanceMetricSortIterm
Parameter	Type	Description
metric_name	String	Definition Monitoring metric name. Range N/A
dimensions	Array of strings	Definition Monitoring dimension. Range N/A
keys	Array of strings	Definition List of dimension names of the top N metrics. Range N/A
values	Array of strings	Definition List of dimension values of the top N metrics. Range N/A
topic_broker	Array of objects	Definition Top N topics with the highest values. For each topic, list the top N brokers and their values. Range N/A
broker_topic	Array of objects	Definition Top N brokers with the highest values. For each broker, list the top N topics and their values. Range N/A
unit	String	Definition Unit. Range N/A

**Table 5** InstanceMetricResources
Parameter	Type	Description
node_num	Integer	Definition Number of nodes. Range N/A
max_partitions	Integer	Definition Maximum number of partitions. Range N/A
remain_partitions	Integer	Definition Number of remaining partitions. Range N/A
network_band	Integer	Definition Network bandwidth. Range N/A
storage_band	Integer	Definition Disk bandwidth. Range N/A
storage_spec_code	String	Definition Disk I/O type. Range N/A
storage_space	Integer	Definition Storage space. Range N/A
total_storage_space	Integer	Definition Total storage space. Range N/A
used_storage_space	Integer	Definition Used storage space. Range N/A

**Table 6** InstanceBrokerConnections
Parameter	Type	Description
count	Integer	Definition Total number of connections. Range N/A
ip	String	Definition IP address. Range N/A

Example Requests

GET https://{endpoint}/v2/{project_id}/rocketmq/{instance_id}/metric-dashboard

Example Responses

Status code: 200

{
  "metric_topn" : {
    "consumer_messages_consumed" : {
      "metric_name" : "consumer_messages_consumed",
      "dimensions" : [ "kafka_instance_id", "kafka_groups" ],
      "keys" : [ "consumer-id", "consumer_id", "consumer_id1", "get-sync-group2", "get-sync-group0", "get-sync-group1" ],
      "values" : [ 7.0, 5.0, 5.0, 0.0, 0.0, 0.0 ]
    },
    "consumer_messages_remained" : {
      "metric_name" : "consumer_messages_remained",
      "dimensions" : [ "kafka_instance_id", "kafka_groups" ],
      "keys" : [ "consumer-id", "consumer_id", "consumer_id1", "get-sync-group2", "get-sync-group0", "get-sync-group1" ],
      "values" : [ 2.0, 2.0, 0.0, 0.0, 0.0, 0.0 ]
    },
    "broker_disk_read_rate" : {
      "metric_name" : "broker_disk_read_rate",
      "dimensions" : [ "kafka_instance_id", "kafka_broker" ],
      "keys" : [ "broker-2", "broker-3", "broker-0", "broker-1" ],
      "values" : [ 0.0, 0.0, 0.0, 0.0 ]
    },
    "topic_messages" : {
      "metric_name" : "topic_messages",
      "dimensions" : [ "kafka_instance_id", "kafka_topics" ],
      "keys" : [ "topic-1", "topic-2" ],
      "values" : [ 0.0, 0.0 ]
    },
    "network_bandwidth_usage" : {
      "metric_name" : "network_bandwidth_usage",
      "dimensions" : [ "kafka_instance_id", "kafka_broker" ],
      "keys" : [ "broker-1", "broker-0", "broker-2", "broker-3" ],
      "values" : [ 0.025272321, 0.023347199, 0.02296832, 0.01839104 ]
    },
    "topic_bytes_in_rate" : {
      "metric_name" : "topic_bytes_in_rate",
      "dimensions" : [ "kafka_instance_id", "kafka_topics" ],
      "keys" : [ "topic-1", "topic-2" ],
      "values" : [ 0.0, 0.0 ]
    },
    "broker_cpu_usage" : {
      "metric_name" : "broker_cpu_usage",
      "dimensions" : [ "kafka_instance_id", "kafka_broker" ],
      "keys" : [ "broker-1", "broker-0", "broker-2", "broker-3" ],
      "values" : [ 16.0, 12.0, 11.0 ]
    },
    "topic_bytes_out_rate" : {
      "metric_name" : "topic_bytes_out_rate",
      "dimensions" : [ "kafka_instance_id", "kafka_topics" ],
      "keys" : [ "topic-1", "topic-614926242" ],
      "values" : [ 0.0, 0.0 ]
    },
    "resources" : {
      "node_num" : null,
      "max_partitions" : null,
      "remain_partitions" : null,
      "network_band" : null,
      "storage_band" : null,
      "storage_spec_code" : "dms.physical.storage.high.v2",
      "storage_space" : 248,
      "total_storage_space" : 400,
      "used_storage_space" : 0
    },
    "dims_metric_topn" : [ ],
    "broker_connections" : { }
  }
}

Status Codes

Status Code	Description
200	Query succeeded.

Error Codes

See Error Codes.

Parent Topic: Other APIs

Previous topic: Querying Kafka Instance Monitoring Dimensions

Next topic: Querying vCPUs of a Kafka Flavor