
# APIG支持的监控指标
本节定义了API网关服务上报云监控服务的监控指标的命名空间、监控指标列表和维度定义，用户可以通过云监控服务提供的管理控制台或[API接口](https://support.huaweicloud.com/api-ces/zh-cn_topic_0171212514.html)来检索API网关服务产生的监控指标和告警信息。
![](https://support.huaweicloud.com/usermanual-apig/public_sys-resources/note_3.0-zh-cn.png)
- 云监控服务最大支持4个层级维度，维度编号从0开始，编号3为最深层级。例如监控指标中的维度信息为"instance_id，api_id"时，表示对应的监控指标的维度存在层级关系，且"instance_id"为0层，"api_id"为1层。
- 如果某个监控指标在当前APIG实例中不支持，请[提交工单](https://support.huaweicloud.com/usermanual-ticket/zh-cn_topic_0127038618.html)升级实例到最新版本。
 
#### 命名空间
SYS.APIC
#### 监控指标
表1监控指标说明 
| 指标ID                                    | 指标名称            | 指标含义                                                             | 取值范围                                     | 单位        | 进制       | 维度                                                           | 监控周期（原始指标） |
|:---|:---|:---|:---|:---|:---|:---|:---|
| throttled_calls                         | API被流控的调用次数     | 该指标表示API被流控之后累计的调用次数                                             | ≥0                                       | Times/min | 不涉及      | 专享版API网关实例（instance_id）                                      | 1分钟        |
| requests                                | 接口调用次数          | 该指标表示API调用次数                                                     | ≥0                                       | Times/min | 不涉及      | 专享版API网关实例（instance_id）  | 1分钟        |
| req_count_error                         | 异常次数            | 该指标表示API总的错误次数                                                   | ≥0                                       | Times/min | 不涉及      | 单个API（instance_id,api_id）                                    | 1分钟        |
| req_count_5xx                           | 5xx调用次数         | 该指标表示API的5xx调用次数                                                 | ≥0                                       | Times/min | 不涉及      | 单个API（instance_id,api_id）                                    | 1分钟        |
| req_count_4xx                           | 4xx调用次数         | 该指标表示API的4xx调用次数                                                 | ≥0                                       | Times/min | 不涉及      | 单个API（instance_id,api_id）                                    | 1分钟        |
| req_count_2xx                           | 2xx调用次数         | 该指标表示API的2xx调用次数                                                 | ≥0                                       | Times/min | 不涉及      | 单个API（instance_id,api_id）                                    | 1分钟        |
| req_count                               | 接口调用次数          | 该指标表示API调用次数                                                     | ≥0                                       | Times/min | 不涉及      | 单个API（instance_id,api_id）                                    | 1分钟        |
| output_throughput                       | 流出流量            | 该指标表示API的流出流量                                                    | ≥0                                       | Byte      | 1000(SI) | 单个API（instance_id,api_id）                                    | 1分钟        |
| max_latency                             | 最大延迟毫秒数         | 该指标表示API的最大延迟毫秒数                                                 | ≥0                                       | ms        | 不涉及      | 专享版API网关实例（instance_id）                                      | 1分钟        |
| max_latency                             | 最大延迟毫秒数         | 该指标表示API的最大延迟毫秒数                                                 | ≥0                                       | ms        | 不涉及      | 单个API（instance_id,api_id）                                    | 1分钟        |
| input_throughput                        | 流入流量            | 该指标表示API的流入流量                                                    | ≥0                                       | Byte      | 1000(SI) | 单个API（instance_id,api_id）                                    | 1分钟        |
| error_5xx                               | 5xx调用次数         | 该指标表示API的5xx调用次数                                                 | ≥0                                       | Times/min | 不涉及      | 专享版API网关实例（instance_id）                                      | 1分钟        |
| error_4xx                               | 4xx调用次数         | 该指标表示API的4xx调用次数                                                 | ≥0                                       | Times/min | 不涉及      | 专享版API网关实例（instance_id）                                      | 1分钟        |
| avg_latency                             | 平均延迟毫秒数         | 该指标表示API的平均延迟毫秒数                                                 | ≥0                                       | ms        | 不涉及      | 专享版API网关实例（instance_id）                                      | 1分钟        |
| avg_latency                             | 平均延迟毫秒数         | 该指标表示API的平均延迟毫秒数                                                 | ≥0                                       | ms        | 不涉及      | 单个API（instance_id,api_id）                                    | 1分钟        |
| node_system_load                        | 网关节点系统负载        | 该指标用于统计当前数据面网关节点负载详情，1表示低水位，2表示中水位，3表示高水位                        | 1，2，3，                                   | count     | 不涉及      | 单个网关节点（instance_id,node_ip）                                  | 1分钟        |
| node_cpu_usage                          | 网关节点cpu使用率      | 该指标用于统计当前数据面网关节点cpu使用率                                           | ≥0  | %         | 不涉及      | 单个网关节点（instance_id,node_ip）                                  | 1分钟        |
| node_memory_usage                       | 网关节点内存使用率       | 该指标用于统计当前数据面网关节点内存使用率                                            | ≥0  | %         | 不涉及      | 单个网关节点（instance_id,node_ip）                                  | 1分钟        |
| inbound_downstream_bandwidth            | 公网入口入网带宽        | 该指标用于统计入API网关的网络速度                                               | ≥0   | bit/s     | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| inbound_down_stream                     | 公网入口入网流量        | 该指标用于统计入API网关的网络流量                                               | ≥0  | Byte      | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| inbound_downstream_bandwidth_usage      | 公网入口入网带宽使用率     | 该指标用于统计入API网关的带宽使用率，当带宽大小调整时，该指标需要数分钟完成规格同步，之后恢复正常使用率上报          | ≥0   | %         | 不涉及      | 专享版API网关实例（instance_id）                                      | 1分钟        |
| inbound_upstream_bandwidth              | 公网入口出网带宽        | 该指标用于统计出API网关的网络速度                                               | ≥0  | bit/s     | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| inbound_up_stream                       | 公网入口出网流量        | 该指标用于统计出API网关的网络流量                                               | ≥0    | Byte      | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| inbound_upstream_bandwidth_usage        | 公网入口出网带宽使用率     | 该指标用于统计出API网关的带宽使用率，当带宽大小调整时，该指标需要数分钟完成规格同步，之后恢复正常使用率上报          | ≥0   | %         | 不涉及      | 专享版API网关实例（instance_id）                                      | 1分钟        |
| outbound_downstream_bandwidth           | 公网出口入网带宽        | 该指标用于统计入API网关的网络速度                                               | ≥0  | bit/s     | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| outbound_down_stream                    | 公网出口入网流量        | 该指标用于统计入API网关的网络流量                                               | ≥0   | Byte      | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| outbound_downstream_bandwidth_usage     | 公网出口入网带宽使用率     | 该指标用于统计入API网关的带宽使用率，当带宽大小调整时，该指标需要数分钟完成规格同步，之后恢复正常使用率上报          | ≥0     | %         | 不涉及      | 专享版API网关实例（instance_id）                                      | 1分钟        |
| outbound_upstream_bandwidth             | 公网出口出网带宽        | 该指标用于统计出API网关的网络速度                                               | ≥0   | bit/s     | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| outbound_up_stream                      | 公网出口出网流量        | 该指标用于统计出API网关的网络流量                                               | ≥0  | Byte      | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| outbound_upstream_bandwidth_usage       | 公网出口出网带宽使用率     | 该指标用于统计出API网关的带宽使用率，当带宽大小调整时，该指标需要数分钟完成规格同步，之后恢复正常使用率上报          | ≥0     | %         | 不涉及      | 专享版API网关实例（instance_id）                                      | 1分钟        |
| ipv6_inbound_downstream_bandwidth       | 公网IPV6入口入网带宽    | 该指标用于统计由IPV6入口地址入API网关的网络速度                                      | ≥0                                       | bit/s     | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| ipv6_inbound_down_stream                | 公网IPV6入口入网流量    | 该指标用于统计由IPV6入口地址入API网关的网络流量                                      | ≥0                                       | Byte      | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| ipv6_inbound_downstream_bandwidth_usage | 公网IPV6入口入网带宽使用率 | 该指标用于统计由IPV6入口地址入API网关的带宽使用率，当带宽大小调整时，该指标需要数分钟完成规格同步，之后恢复正常使用率上报 | ≥0                                       | %         | 不涉及      | 专享版API网关实例（instance_id）                                      | 1分钟        |
| ipv6_inbound_upstream_bandwidth         | 公网IPV6入口出网带宽    | 该指标用于统计由IPV6入口地址出API网关的网络速度                                      | ≥0                                       | bit/s     | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| ipv6_inbound_up_stream                  | 公网IPV6入口出网流量    | 该指标用于统计由IPV6入口出API网关的网络流量                                        | ≥0                                       | Byte      | 1000(SI) | 专享版API网关实例（instance_id）                                      | 1分钟        |
| ipv6_inbound_upstream_bandwidth_usage   | 公网IPV6入口出网带宽使用率 | 该指标用于统计由IPV6入口地址出API网关的带宽使用率，当带宽大小调整时，该指标需要数分钟完成规格同步，之后恢复正常使用率上报 | ≥0                                       | %         | 1        | 专享版API网关实例（instance_id）                                      | 1分钟        |
   
对于有多层测量维度的测量对象，使用接口查询监控指标时，需要代入具体指标的维度层级关系。
例如，需要查询单个API的调用次数，该指标的维度信息为"instance_id,api_id"，表示instance_id为0层，api_id为1层。
- 通过API查询单个监控指标时，api_id的维度信息代入样例如下：
  ```
  dim.0=instance_id,3d65c1ac9a9f4c5fa05435184a087bb2&dim.1=api_id,6666cd76f96956469e7be39d750cc7d9
  ```
  其中，3d65c1ac-9a9f-4c5f-a054-35184a087bb2和6666cd76f96956469e7be39d750cc7d9分别为instance_id和api_id的维度值，具体获取方法请参见[维度]内容获取指导。
  
- 通过API批量查询监控指标时，api_id的维度信息代入样例如下：
  ```
  "dimensions": [ 
                   { 
                       "name": "instance_id", 
                       "value": "3d65c1ac9a9f4c5fa05435184a087bb2"    
                   }, 
                   { 
                       "name": "api_id", 
                       "value": "6666cd76f96956469e7be39d750cc7d9" 
                   } 
               ]
  ```
  其中，3d65c1ac9a9f4c5fa05435184a087bb2和6666cd76f96956469e7be39d750cc7d9分别为instance_id和api_id的维度值，具体获取方法请参见[维度]内容获取指导。
  
 
 #### 维度
表2维度定义说明 
| Key                 | Value                                                                                                                                                                                    |
|:---|:---|
| instance_id         | 专享版API网关实例ID，例如：8df0xxxx000p。 该取值的获取方式为：调用[查看专享版实例列表](https://support.huaweicloud.com/api-apig/ListInstancesV2.html)API，从接口返回的响应参数中提取。                    |
| instance_id，node_ip | 专享版API网关节点，例如：8df0xxxx000p，192.168.10.10。 该取值的获取方式为：调用[查看专享版实例详情](https://support.huaweicloud.com/api-apig/ShowDetailsOfInstanceV2.html)API，从接口返回的响应参数中提取。 |
| instance_id，api_id  | 单个API，例如：8df0xxxx000p，6666xxxxc7d9。 该取值的获取方式为：调用[查询API列表](https://support.huaweicloud.com/api-apig/ListApisV2.html)API，从接口返回的响应参数中提取。                    |
   
