记录对亚马逊 Data Firehose 的 API 调用 - Amazon API Gateway
API Gateway 的 Firehose 日志格式Firehose 日志记录的权限使用 API Gateway 控制台设置 Firehose 访问日志
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

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

记录对亚马逊 Data Firehose 的 API 调用

为了帮助调试与客户访问您的 API 相关的问题，您可以记录 Amazon Data Firehose 的 API 调用。有关 Firehose 的更多信息，请参阅什么是亚马逊数据 Fire hose？ 。

对于访问日志记录，您只能启用 CloudWatch 或 FireHose，不能同时启用两者。但是，您可以启用执行日志，启 CloudWatch 用 Firehose 进行访问日志。

API Gateway 的 Firehose 日志格式

Firehose 日志记录使用的格式与日志记录格式相同。CloudWatch

Firehose 日志记录的权限

在舞台上启用 Firehose 访问日志时，如果该角色尚不存在，API Gateway 会在您的账户中创建一个服务相关角色。该角色被命名为 AWSServiceRoleForAPIGateway，并且已将 APIGatewayServiceRolePolicy 托管策略附加到该角色。有关服务相关角色的更多信息，请参阅使用服务相关角色。

注意

你的 Firehose 直播的名称必须是。amazon-apigateway-{your-stream-name}

使用 API Gateway 控制台设置 Firehose 访问日志

要设置 API 日志记录，您必须已经将 API 部署到某个阶段。您还必须创建了 Firehose 直播。

  1. 通过以下网址登录到 Amazon API Gateway 控制台：https://console.aws.amazon.com/apigateway。

  2. 请执行以下操作之一：

    1. 选择现有 API，然后选择一个阶段。

    2. 创建 API 并将其部署到阶段。

  3. 在主导航窗格中，选择阶段。

  4. 在日志和跟踪部分中，选择编辑。

  5. 要启用对 Firehose 直播的访问日志记录，请执行以下操作：

    1. 开启自定义访问日志记录。

    2. 在访问日志目标 ARN 中，输入 Firehose 直播的 ARN。ARN 格式为 arn:aws:firehose:{region}:{account-id}:deliverystream/amazon-apigateway-{your-stream-name}。

      注意

      你的 Firehose 直播的名称必须是。amazon-apigateway-{your-stream-name}

    3. 对于日志格式，输入日志格式。您可以选择 CLF、JSON、XML 或 CSV。要了解有关示例日志格式的更多信息，请参阅用于 API Gateway 的 CloudWatch 日志格式。

  6. 选择 ‬保存更改。

API Gateway 现在可以将向你的 API 发出的请求记录到 Firehose。在更新阶段设置、日志或阶段变量时，您无需重新部署 API。