跳至内容

如何收集 API Gateway 扩展请求 ID?

1 分钟阅读
0

我想收集 Amazon API Gateway 扩展请求 ID。

解决方法

扩展请求 ID 包含用于调试问题和进行故障排除的信息。

要收集 REST API 或 HTTP API 的扩展请求 ID,请检查访问日志记录、执行日志记录或 HTTP 响应标头。

启用 API 的日志记录

如果您尚未启用日志记录,请启用,以便将 HTTP API 的日志写入 Amazon CloudWatch Logs。要启用 REST API 的日志记录,请参阅为 API Gateway 中的 REST API 设置 CloudWatch 日志记录。

注意: 必须激活访问日志记录才能捕获扩展请求 ID。访问日志会捕获所有到达 API Gateway 的请求,包括被身份验证、授权、节流和 AWS WAF 拒绝的请求。

查看访问日志记录

要查看谁访问了您的 API 以及如何访问,请查看您的访问日志。要在访问日志中获取请求 ID,请在自定义日志内容时添加 context.extendedRequestId 上下文变量。

查看 REST API 的执行日志记录

在 API Gateway 为 REST API 管理的执行日志中查看扩展请求 ID。

扩展请求 ID 显示为以下格式之一:

  • 日志组格式: API-Gateway-Execution-Logs_{rest-api-id}/{stage_name}
  • 扩展请求 ID 格式: “XxxXXXxx=”

注意: 执行日志记录不支持 HTTP API。

查看 HTTP 响应标头

您可以在 API 响应标头中找到扩展请求 ID。

要查看响应标头,请运行以下带有详细标志 (-v) 的 curl 命令:

curl -v https://your-api-id.execute-api.region.amazonaws.com/stage/resource

REST API 响应标头示例:

x-amz-apigw-id: b5i0ig3WIAMEVOQ=

HTTP 响应标头示例:

apigw-requestid: b5i0ig3WIAMEVOQ=

相关信息

API Gateway 的访问日志记录的变量