阿里云 API 网关

采集阿里云 API 网关监控数据

配置¶

安装 Func¶

推荐开通观测云集成 - 扩展 - 托管版 Func

如果自行部署 Func 参考自行部署 Func

安装脚本¶

提示：请提前准备好符合要求的阿里云 AK（简单起见，可直接授予全局只读权限ReadOnlyAccess）

登陆Func 控制台，点击【脚本市场】，进入观测云脚本市场，搜索:integration_alibabacloud_api_gateway
点击【安装】后，输入相应的参数：阿里云 AK ID 、AK Secret 及账户名。
点击【部署启动脚本】，系统会自动创建 Startup 脚本集，并自动配置相应的启动脚本。
开启后可以在「管理 / 自动触发配置」里看到对应的自动触发配置。点击【执行】，即可立即执行一次，无需等待定期时间。稍等片刻，可以查看执行任务记录以及对应日志。

验证¶

在「管理 / 自动触发配置」确认对应的任务是否已存在对应的自动触发配置，同时可以查看对应任务记录及日志检查是否有异常
在观测云，「基础设施 / 自定义」中查看是否存在资产信息
在观测云，「指标」查看是否有对应监控数据

指标¶

配置好阿里云-云监控,默认的指标集如下, 可以通过配置的方式采集更多的指标阿里云云监控指标详情

API 网关¶

MetricName	指标类型	MetricDescribe	Dimensions	Statistics	Unit
Latency	实例维度	响应时间	userId,region,apiUid	Average	ms
SumQPS	实例维度	总体请求次数	userId,region,apiUid	Count	count
TrafficRX	实例维度	流入流量	userId,region,apiUid	Sum	B
TrafficTX	实例维度	流出流量	userId,region,apiUid	Sum	B
code2XX	实例维度	返回码2XX个数	userId,region,apiUid	Value	count
code429	实例维度	返回码429个数	userId,region,apiUid	Value	count
code4XX	实例维度	返回码4XX个数	userId,region,apiUid	Value	count
code5XX	实例维度	返回码5XX个数	userId,region,apiUid	Value	count
error_count_instance	apigateway	实例请求错误数	userId,region,apiUid	Sum	count
instance_lost	apigateway	实例节点丢失比例	userId,region,instanceId	Average	%
request_count_instance	apigateway	实例总请求数	userId,region,instanceId	Sum	count

API 分组¶

MetricName	指标类型	MetricDescribe	Dimensions	Statistics	Unit
Latency_group	apiGroupUid	响应时间	userId,region,apiGroupUid	Average	ms
SumQPS_group	apiGroupUid	总体请求次数	userId,region,apiGroupUid	Count	count
TrafficRX_group	apiGroupUid	流入流量	userId,region,apiGroupUid	Sum	B
TrafficTX_group	apiGroupUid	流出流量	userId,region,apiGroupUid	Sum	B
code2XX_group	apiGroupUid	返回码2XX个数	userId,region,apiGroupUid	Value	count
code429_group	apiGroupUid	返回码429个数	userId,region,apiGroupUid	Value	count
code4XX_group	apiGroupUid	返回码4XX个数	userId,region,apiGroupUid	Value	count
code5XX_group	apiGroupUid	返回码5XX个数	userId,region,apiGroupUid	Value	count

API 实例¶

MetricName	指标类型	MetricDescribe	Dimensions	Statistics	Unit
Latency_instance	实例维度	响应时间	userId,region,instanceId	Average	ms
SumQPS_instance	实例维度	总体请求次数	userId,region,instanceId	Count	count
TrafficRX_instance	实例维度	流入流量	userId,region,instanceId	Sum	B
TrafficTX_instance	实例维度	流出流量	userId,region,instanceId	Sum	B
code2XX_instance	实例维度	返回码2XX个数	userId,region,instanceId	Value	count
code429_instance	实例维度	返回码429个数	userId,region,instanceId	Value	count
code4XX_instance	实例维度	返回码4XX个数	userId,region,instanceId	Value	count
code5XX_instance	实例维度	返回码5XX个数	userId,region,instanceId	Value	count

对象¶

采集到的阿里云 API 网关对象数据结构, 可以从「基础设施-自定义」里看到对象数据

{
  "measurement": "aliyun_apigateway",
  "tags": {
    "instance_spec"             : "api.s1.small",
    "instance_name"             : "xxxx-test",
    "instance_id"               : "i-xxxxx",
    "region_id"                 : "cn-hangzhou"
  },
  "fields": {
    "zone_local_name"                   : "xxxxx",
    "internet_egress_address"           : "114.55.1xx.xxx",
    "created_time"                     : "2025/09/01 16:10:09",
    "vpc_egress_address"                : "100.xxx.xxx.0/xx",
    "instance_spec_attributes"          : "xxxxx",
    "instance_charge_type"              : "PayAsYouGo",
    "vpc_slb_intranet_enable"            : "False",
    "instance_type"                    : "VPC_SHARED",
    "status"                          : "RUNNING",
    "zone_id"                          : "cn-hangzhou",
    "instance_cidr_block"               : "172.16.xx.xx/xx",
    "ipv_6_acl_status"                   : "off",
    "egress_ipv_6_enable"                : "False",
    "maintain_start_time"               : "18:00Z",
    "maintain_end_time"                 : "22:00Z"
  }
}

注意：tags、fields中的字段可能会随后续更新有所变动