使用 HTTP API 的指标 - Amazon API Gateway
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

使用 HTTP API 的指标

您可以使用 CloudWatch 监控 API 执行,这将从 API Gateway 收集原始数据,并将数据处理为便于阅读的近乎实时的指标。这些统计数据会保存 15 个月,从而使您能够访问历史信息,并能够更好地了解您的 Web 应用程序或服务的执行情况。默认情况下,API Gateway 指标数据会在一分钟时段内自动发送到 CloudWatch。要监控您的指标,请为您的 API 创建 CloudWatch 控制面板。有关如何创建 CloudWatch 控制面板的更多信息,请参阅《Amazon CloudWatch 用户指南》中的创建 CloudWatch 控制面板。有关更多信息,请参阅 Amazon CloudWatch 用户指南 中的什么是 Amazon CloudWatch?

HTTP API 支持以下指标。您还可以启用详细指标,以便将路由级指标写入到 Amazon CloudWatch。

指标 说明
4xx 在给定期间捕获的客户端错误数。
5xx 在给定期间捕获的服务器端错误数。
计数 给定期间内的 API 请求总数。
IntegrationLatency 从 API Gateway 将请求中继到后端到其从后端收到响应所经过的时间。
延迟 从 API Gateway 从客户端收到请求到其将响应返回给客户端所经过的时间。延迟包括集成延迟和其他 API Gateway 开销。
DataProcessed 处理的数据量(以字节为单位)。

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

维度 说明
ApiId 筛选具有指定 API ID 的 API 的 API Gateway 指标。
ApiId、阶段 针对具有指定 API ID 和阶段 ID 的 API 阶段筛选 API Gateway 指标。
ApiId、阶段、路由

针对具有指定 API ID、阶段 ID 和路由 ID 的 API 方法筛选 API Gateway 指标。

除非您明确启用了详细的 CloudWatch 指标,否则 API Gateway 不会发送这些指标。要执行此操作,您可以通过调用 API Gateway V2 REST API 的 UpdateStage 操作,将 detailedMetricsEnabled 属性更新为 true。或者,您也可以调用 update-stage Amazon CLI 命令,以将 DetailedMetricsEnabled 属性更新为 true。启用这些指标会对您的账户额外计费。有关定价信息,请参阅 Amazon CloudWatch 定价