查询指标列表 - QueryMetrics

功能介绍

查询系统当前可监控指标列表，可以指定指标命名空间、指标名称、维度、排序方式，起始记录和最大记录条数过滤查询结果。

云服务资源删除后，会保留3个小时的数据缓存，在3小时之内还能查到资源对应的监控指标，属于正常现象。

调用方法

请参见如何调用API。

URI

GET /V1.0/{project_id}/metrics

请求消息

• 请求参数

  无。

• 请求样例
  请求样例一：查询当前可监控所有指标列表。

  GET https://{云监控的终端节点}/V1.0/{project_id}/metrics

  请求样例二：查询终端入云VPN网关ID为4ae00000-0000-0000-0000-0000b1428ef7的监控指标连接数，结果按时间戳降序保留10条数据。

  GET https://{云监控的终端节点}/V1.0/{project_id}/metrics?namespace=SYS.VPN&metric_name=gateway_connection_num&dim.0=p2c_vpn_gateway_id,4ae00000-0000-0000-0000-0000b1428ef7&limit=10&order=desc

响应消息

• 响应参数

  返回状态码为 200: 查询成功。

  表3 响应Body参数列表

  名称	类型	描述
  metrics	Array of Metrics objects	指标对象列表。
  meta_data	MetaData object	查询结果元数据信息，包括分页信息等。

  表4 Metrics

  名称	类型	描述
  namespace	String	指标所属命名空间。
  dimensions	Array of Dimensions objects	指标维度列表。
  metric_name	String	指标名称，如gateway_connection_num。
  unit	String	指标单位。

  表5 Dimensions

  名称	类型	描述
  name	String	监控维度名称。 终端入云VPN网关的维度为p2c_vpn_gateway_id。 站点入云VPN维度请参考支持的监控指标（站点入云VPN企业版），可参考维度中key字段。
  value	String	维度取值，例如终端入云VPN网关的ID。

  表6 MetaData

  名称	类型	描述
  count	Integer	当前返回结果条数。
  marker	String	查询本页的起始标记位，为空时为查询第一页。查询下一页的marker可以根据上一页响应的meta_data对象中的marker填写。
  total	Integer	指标查询总条数。

• 响应样例

  {
      "metrics": [
          {
              "namespace": "SYS.VPN",
              "dimensions": [
                  {
                      "name": "p2c_vpn_gateway_id",
                      "value": "72fe0000-0000-0000-0000-0000f0efd460"
                  }
              ],
              "metric_name": "gateway_connection_num",
              "unit": "count"
          }
      ],
      "meta_data": {
          "count": 1,
          "marker": "SYS.VPN.gateway_connection_num.p2c_vpn_gateway_id:72fe0000-0000-0000-0000-0000f0efd460.index:756558082",
          "total": 16
      }
  }

状态码

请参见状态码。