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

使用 AWS Config 监控 API Gateway API 配置

您可以使用 AWS Config 来记录对您的 API Gateway API 资源所做的配置更改,并根据资源更改发送通知。维护 API Gateway 资源的配置更改历史记录对于运行问题排查、审计和合规性使用案例非常有用。

AWS Config 可以跟踪以下项的更改:

  • API 阶段配置,如:

    • 缓存集群设置

    • 限制设置

    • 访问日志设置

    • 为阶段设置的活动部署

  • API 配置,如:

    • 终端节点配置

    • 版本

    • 协议

    • 标签

此外,AWS Config Rules 功能让您能够定义配置规则并自动检测、跟踪和提醒对于这些规则的违反行为。通过跟踪对这些资源配置属性的更改,您还可以为 API Gateway 资源编写更改触发的 AWS Config 规则,并根据最佳实践测试资源配置。

您可以使用 AWS Config 控制台或 AWS CLI 为账户启用 AWS Config。选择要跟踪更改的资源类型。如果您之前配置了 AWS Config 来记录所有资源类型,则这些 API Gateway 资源将自动记录到您的账户中。AWS Config 中对于 Amazon API Gateway 的支持在所有 AWS 公共区域和 AWS GovCloud (US) 中可用。有关受支持区域的完整列表,请参阅 AWS General Reference 中的区域和终端节点

支持的资源类型

以下 API Gateway 资源类型与 AWS Config 集成并记录到 AWS Config 支持的 AWS 资源类型和资源关系中:

  • AWS::ApiGatewayV2::Api (WebSocket API)

  • AWS::ApiGateway::RestApi (REST API)

  • AWS::ApiGatewayV2::Stage(WebSocket API 阶段)

  • AWS::ApiGateway::Stage(REST API 阶段)

有关 AWS Config 的更多信息,请参阅 AWS Config Developer Guide。有关定价信息,请参阅 AWS Config 定价信息页

重要

如果您在部署 API 后更改以下任一 API 属性,则必须 重新部署 API 以传播更改。否则,您将在 AWS Config 控制台中看到属性更改,但之前的属性设置仍有效;API 的运行时行为将保持不变。

  • AWS::ApiGateway::RestApibinaryMediaTypes, minimumCompressionSize, apiKeySource

  • AWS::ApiGatewayV2::ApiapiKeySelectionExpression

设置 AWS Config

要初次设置 AWS Config,请参阅 AWS Config Developer Guide中的以下主题。

将 AWS Config 配置为记录 API Gateway 资源

默认情况下,AWS Config 会记录在环境的运行区域中发现的所有受支持类型的区域性资源的配置更改。您可以自定义 AWS Config,使其仅记录特定资源类型的更改或仅记录对全局资源的更改。

要了解区域与全局资源以及了解如何自定义您的 AWS Config 配置,请参阅选择 AWS Config 记录的资源

在 AWS Config 控制台中查看 API Gateway 配置详细信息

您可以使用 AWS Config 控制台来查找 API Gateway 资源,并获取有关其配置的当前和历史详细信息。以下过程显示了如何查找有关 API Gateway API 的信息。

在 AWS Config 控制台中查找 API Gateway 资源

  1. 打开 AWS Config 控制台

  2. 选择 Resources (资源)

  3. Resource (资源) 清单页面上,选择 Resources (资源)

  4. 打开 Resource type (资源类型) 菜单,滚动到 APIGateway 或 APIGatewayV2,然后选择一个或多个 API Gateway 资源类型。

  5. 选择 Look up (查找)

  6. 选择 AWS Config 显示的资源列表中的一个资源 ID。AWS Config 将显示配置详细信息以及有关所选资源的其他信息。

  7. 要查看记录的配置的完整详细信息,请选择 View Details (查看详细信息)

要了解在此页面上查找资源和查看信息的更多方法,请参阅 AWS Config Developer Guide 中的查看 AWS 资源配置和历史记录

使用 AWS Config 规则评估 API Gateway 资源

您可以创建 AWS Config 规则,这些规则规定了您的 API Gateway 资源的理想配置设置。您可以使用预定义的 AWS Config 托管规则,也可以定义自定义规则。AWS Config 会持续跟踪对您的资源配置的更改,以确定这些更改是否符合规则中设定的所有条件。AWS Config 控制台将显示您的规则与资源的合规性状态。

如果某个资源违反了某规则并且被标记为“不合规”,则 AWS Config 可以提醒您使用 Amazon Simple Notification Service 开发人员指南 (Amazon SNS) 主题。要以编程方式使用这些 AWS Config 提醒中的数据,请将 Amazon Simple Queue Service (Amazon SQS) 队列用作 Amazon SNS 主题的通知终端节点。

要了解有关设置和使用规则的更多信息,请参阅 AWS Config Developer Guide 中的使用规则评估资源