Amazon CloudWatch
用户指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

Amazon API Gateway 指标和维度

下面列出了 API 网关 发送到 Amazon CloudWatch 的指标和维度。有关更多信息,请参阅 Amazon API Gateway 开发人员指南中的使用 Amazon CloudWatch 监控 API 执行

API 网关 指标

Amazon API Gateway 每分钟向 CloudWatch 发送一次指标数据。

AWS/ApiGateway 命名空间包括以下指标。

指标 描述

4XXError

在指定期间捕获的客户端错误数。

Sum 统计数据表示此指标,即给定期间内 4XXError 错误的总计数。Average 统计数据表示 4XXError 错误率,即 4XXError 错误的总计数除以该期间中的请求总数。分母对应于计数指标 (见下)。

单位:计数

5XXError

在给定期间捕获的服务器端错误数。

Sum 统计数据表示此指标,即给定期间内 5XXError 错误的总计数。Average 统计数据表示 5XXError 错误率,即 5XXError 错误的总计数除以该期间中的请求总数。分母对应于计数指标 (见下)。

单位:计数

CacheHitCount

在给定期间内从 API 缓存中提供的请求数。

Sum 统计数据表示此指标,即指定期间内缓存命中的总计数。Average 统计数据表示缓存命中率,即缓存命中的总计数除以该期间中的请求总数。分母对应于计数指标 (见下)。

单位:计数

CacheMissCount

在启用 API 缓存时,在指定期间内由后端所服务的请求的数量。

Sum 统计数据表示此指标,即指定期间内缓存未命中的总计数。Average 统计数据表示缓存命中率,即缓存未命中的总计数除以该期间中的请求总数。分母对应于计数指标 (见下)。

单位:计数

Count

给定期间内的 API 请求总数。

SampleCount 统计数据表示此指标。

单位:计数

IntegrationLatency

从 API 网关 将请求中继到后端到其从后端收到响应所经过的时间。

单位:毫秒

延迟

从 API 网关 从客户端收到请求到其将响应返回给客户端所经过的时间。延迟包括集成延迟和其他 API 网关 开销。

单位:毫秒

指标的维度

您可以使用下表中的维度筛选 API 网关 指标。

维度 描述

ApiName

针对具有指定 API 名称的 API 筛选 API 网关 指标。

ApiName、Method、Resource、Stage

针对指定 API、阶段、资源和方法的 API 方法筛选 API 网关 指标。

仅当您显式启用详细 CloudWatch 指标时,API 网关 才会发送这些指标。为此,您可以在控制台中,在阶段的 Settings 选项卡下选中 Enable CloudWatch Metrics。或者,您也可以调用 API 网关 REST API 的 stage:update 操作,以将 metricsEnabled 属性更新为 true

启用这些指标会对您的账户额外计费。有关定价信息,请参阅 Amazon CloudWatch 定价

ApiName、Stage

针对指定 API 和阶段的 API 阶段筛选 API 网关 指标。