文档首页/ 分布式消息服务Kafka版/ API参考/ API V2（推荐）/ 其他接口/ 查询监控概览 - ShowMetricDashboard
更新时间：2026-11-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询监控概览 - ShowMetricDashboard

功能介绍

查询监控概览。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

metric_topn

InstanceMetricData object

参数解释：

监控指标Top数据。

取值范围：

不涉及。

resources

InstanceMetricResources object

参数解释：

实例资源信息。

取值范围：

不涉及。

dims_metric_topn

Array of InstanceMetricSortIterm objects

参数解释：

多维度TopN指标数据，比如topic、broker维度。

取值范围：

不涉及。

broker_connections

InstanceBrokerConnections object

参数解释：

节点连接数最高的N个IP及连接数。

取值范围：

不涉及。
表3 InstanceMetricData

参数

参数类型

描述

consumer_messages_consumed

InstanceMetricSortIterm object

参数解释：

消费组消费数量。

取值范围：

不涉及。

consumer_messages_remained

InstanceMetricSortIterm object

参数解释：

消费组消费堆积数。

取值范围：

不涉及。

broker_disk_read_rate

InstanceMetricSortIterm object

参数解释：

broker磁盘读流量。

取值范围：

不涉及。

topic_messages

InstanceMetricSortIterm object

参数解释：

topic消息数。

取值范围：

不涉及。

network_bandwidth_usage

InstanceMetricSortIterm object

参数解释：

broker网络带宽利用率。

取值范围：

不涉及。

topic_bytes_in_rate

InstanceMetricSortIterm object

参数解释：

topic生产流量。

取值范围：

不涉及。

broker_cpu_usage

InstanceMetricSortIterm object

参数解释：

broker的cpu利用率。

取值范围：

不涉及。

topic_bytes_out_rate

InstanceMetricSortIterm object

参数解释：

topic消费流量。

取值范围：

不涉及。
表4 InstanceMetricSortIterm

参数

参数类型

描述

metric_name

String

参数解释：

监控指标名称。

取值范围：

不涉及。

dimensions

Array of strings

参数解释：

监控维度。

取值范围：

不涉及。

keys

Array of strings

参数解释：

值最高的N个指标的维度名列表。

取值范围：

不涉及。

values

Array of strings

参数解释：

值最高的N个指标的维度值列表。

取值范围：

不涉及。

topic_broker

Array of objects

参数解释：

值最高的N个topic，每个topic取值最高的N个broker及其数值列表。

取值范围：

不涉及。

broker_topic

Array of objects

参数解释：

值最高的N个broker，每个broker取值最高的N个topic及其数值列表。

取值范围：

不涉及。

unit

String

参数解释：

单位。

取值范围：

不涉及。
表5 InstanceMetricResources

参数

参数类型

描述

node_num

Integer

参数解释：

节点数量。

取值范围：

不涉及。

max_partitions

Integer

参数解释：

最大分区数。

取值范围：

不涉及。

remain_partitions

Integer

参数解释：

剩余分区数。

取值范围：

不涉及。

network_band

Integer

参数解释：

网络带宽。

取值范围：

不涉及。

storage_band

Integer

参数解释：

磁盘带宽。

取值范围：

不涉及。

storage_spec_code

String

参数解释：

磁盘IO类型。

取值范围：

不涉及。

storage_space

Integer

参数解释：

存储空间。

取值范围：

不涉及。

total_storage_space

Integer

参数解释：

总存储空间。

取值范围：

不涉及。

used_storage_space

Integer

参数解释：

已用存储空间。

取值范围：

不涉及。
表6 InstanceBrokerConnections

参数

参数类型

描述

count

Integer

参数解释：

链接总数。

取值范围：

不涉及。

ip

String

参数解释：

ip。

取值范围：

不涉及。

请求示例

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

响应示例

状态码：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" : { }
  }
}

状态码

状态码

描述

200

查询成功。

错误码

请参见错误码。

父主题： 其他接口