# 查询指标列表 - QueryMetrics #### 功能介绍 查询系统当前可监控指标列表，可以指定指标命名空间、指标名称、维度、排序方式，起始记录和最大记录条数过滤查询结果。 ![](https://support.huaweicloud.com/api-vpn/public_sys-resources/notice_3.0-zh-cn.png) 云服务资源删除后，会保留3个小时的数据缓存，在3小时之内还能查到资源对应的监控指标，属于正常现象。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-vpn/vpn_api_0008.html)。 #### URI GET /V1.0/{project_id}/metrics 表1参数说明 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | project_id | String | 是 | 项目ID，可以通过[获取项目ID](https://support.huaweicloud.com/api-vpn/vpn_api_0051.html)获取项目ID。 | 表2查询检索参数说明 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | namespace | String | 否 | - 功能说明：服务指标命名空间。 - 取值范围：企业版VPN的命名空间为SYS.VPN。 | | metric_name | String | 否 | - 功能说明：指标ID。监控指标请参考[支持的监控指标（站点入云VPN企业版）](https://support.huaweicloud.com/usermanual-vpn/vpn_04_0702.html)和[支持的监控指标（终端入云VPN）](https://support.huaweicloud.com/usermanual-vpn/vpn_04_0707.html)。 - 取值范围：字符长度最短为1，最大为96；必须以字母开头，只能包含0-9/a-z/A-Z/_/-；如：虚拟专用网络中的监控指标gateway_recv_pkt_rate，表示VPN网关的入云包速率。 | | dim | String | 否 | - 功能说明：指标的维度。若指标的维度存在层级关系，需要使用多层级维度方式进行查询。 - 约束：目前最大支持4个层级维度，维度编号从0开始，编号3为最深层级。 - 取值范围：维度格式为dim.{i}=key,value，key的最大长度32，value的最大长度为256。 以下维度说明仅为示例，具体是否支持多维度请参见[支持的监控指标（站点入云VPN企业版）](https://support.huaweicloud.com/usermanual-vpn/vpn_04_0702.html)和[支持的监控指标（终端入云VPN）](https://support.huaweicloud.com/usermanual-vpn/vpn_04_0707.html)中的维度说明。 - 单层级维度：如终端入云VPN网关的连接数（gateway_connection_num），其维度为p2c_vpn_gateway_id，且p2c_vpn_gateway_id为0层，维度信息代入方式如下： dim.0=p2c_vpn_gateway_id,4ae00000-0000-0000-0000-0000b1428ef4。 - 多层级维度：如站点入云VPN连接的SA发送包速率（sa_send_pkt_rate）维度为evpn_sa_id，evpn_sa_id上层维度为evpn_connection_id。evpn_connection_id为0层，evpn_sa_id为1层，其维度信息代入方式如下： dim.0=evpn_connection_id,4ae00000-0000-0000-0000-0000b1428ef5\&dim.1=evpn_sa_id,4ae00000-0000-0000-0000-0000b1428ef6。 | | start | String | 否 | - 功能说明：查询本页的起始标记位，为空时为查询第一页。 - 格式：namespace.metric_name.key:value。例如：start=SYS.VPN.gateway_connection_num.p2c_vpn_gateway_id:4ae0bd2d-a5fb-4155-9775-4eb1b1428ef4.index:756529722。 | | limit | Integer | 否 | - 功能说明：分页查询时每页返回的记录数量。 - 取值范围：\[1, 1000\]。 - 默认取值：1000。 | | order | String | 否 | - 功能说明：用于标识结果排序方法，按时间戳排序。 - 取值范围：只能是asc或者desc。asc为升序，desc为降序。 - 默认取值：asc。 | #### 请求消息 - 请求参数 无。 - 请求样例 请求样例一：查询当前可监控所有指标列表。 ``` 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 | 查询结果元数据信息，包括分页信息等。 | 表4Metrics | 名称 | 类型 | 描述 | |:---|:---|:---| | namespace | String | 指标所属命名空间。 | | dimensions | Array of [Dimensions] objects | 指标维度列表。 | | metric_name | String | 指标名称，如gateway_connection_num。 | | unit | String | 指标单位。 | 表5Dimensions | 名称 | 类型 | 描述 | |:---|:---|:---| | name | String | 监控维度名称。 - 终端入云VPN网关的维度为p2c_vpn_gateway_id。 - 站点入云VPN维度请参考[支持的监控指标（站点入云VPN企业版）](https://support.huaweicloud.com/usermanual-vpn/vpn_04_0702.html)，可参考维度中key字段。 | | value | String | 维度取值，例如终端入云VPN网关的ID。 | 表6MetaData | 名称 | 类型 | 描述 | |:---|:---|:---| | 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 } } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-vpn/vpn_api_0052.html)。