更新时间:2025-10-16 GMT+08:00
分享

APIG支持的监控指标

功能说明

本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。

  • 云监控服务最大支持4个层级维度,维度编号从0开始,编号3为最深层级。例如监控指标中的维度信息为“instance_id,api_id”时,表示对应的监控指标的维度存在层级关系,且“instance_id”为0层,“api_id”为1层。
  • 如果某个监控指标在当前APIG实例中不支持,请提交工单升级实例到最新版本。

命名空间

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分钟

对于有多层测量维度的测量对象,使用接口查询监控指标时,需要代入具体指标的维度层级关系。

例如,需要查询单个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的维度值,具体获取方法请参见“维度”表格中的获取指导。

维度

Key

Value

instance_id

专享版API网关实例ID,例如:8df0xxxx000p。

该取值的获取方式为:调用查看专享版实例列表API,从接口返回的响应参数中提取。

instance_id,node_ip

专享版API网关节点,例如:8df0xxxx000p,192.168.10.10。

该取值的获取方式为:调用查看专享版实例详情API,从接口返回的响应参数中提取。

instance_id,api_id

单个API,例如:8df0xxxx000p,6666xxxxc7d9。

该取值的获取方式为:调用查询API列表API,从接口返回的响应参数中提取。

相关文档