自定义 HTTP API 访问日志 - Amazon API Gateway
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

自定义 HTTP API 访问日志

您可以使用以下变量自定义 HTTP API 访问日志。要了解有关 HTTP API 的访问日志的更多信息,请参阅 为 HTTP API 配置日志记录

参数 说明
$context.accountId

API 拥有者的 AWS 账户 ID。

$context.apiId

API Gateway 分配给您的 API 的标识符。

$context.authorizer.claims.property

成功对方法调用方进行身份验证后从 JSON Web 令牌 (JWT) 返回的声明的属性。有关更多信息,请参阅 使用 JWT 授权方控制对 HTTP API 的访问

注意

调用 $context.authorizer.claims 将返回 null。

$context.awsEndpointRequestId

AWS 终端节点的请求 ID。

$context.dataProcessed 处理的数据量(以字节为单位)。
$context.domainName

用于调用 API 的完整域名。这应与传入的 Host 标头相同。

$context.domainPrefix

$context.domainName 的第一个标签。此标签通常用作调用方/客户标识符。

$context.error.message

包含 API Gateway 错误消息的字符串。

$context.error.messageString $context.error.message 的带引号的值,即 "$context.error.message"
$context.error.responseType

一种 GatewayResponse 类型。有关更多信息,请参阅 使用 CloudWatch 指标监控 WebSocket API 的执行设置网关响应以自定义错误响应

$context.extendedRequestId API Gateway 分配给 API 请求的扩展 ID,其中包含用于调试/故障排除的更有用的信息。
$context.httpMethod

所用的 HTTP 方法。有效值包括:DELETEGETHEADOPTIONSPATCHPOSTPUT

$context.identity.sourceIp

向 API Gateway 发出请求的 TCP 连接的源 IP 地址。

警告

如果有任何机会可以伪造 X-Forwarded-For 标头,则不应信任此值。

$context.identity.userAgent

API 调用方的 User-Agent 标头。

$context.path 请求路径。例如:/{stage}/root/child
$context.protocol 请求的协议,例如,HTTP/1.1
$context.requestId

API Gateway 分配给 API 请求的 ID。

$context.requestTime CLF 格式的请求时间 (dd/MMM/yyyy:HH:mm:ss +-hhmm)。
$context.requestTimeEpoch Epoch 格式的请求时间。
$context.routeKey

API 请求的路由密钥,例如 /pets

$context.stage

API 请求的部署阶段(例如,betaprod)。

$context.integrationErrorMessage

包含集成错误消息的字符串。

$context.integrationLatency 集成延迟(毫秒)。
$context.integrationStatus 对于 Lambda 代理集成,此参数表示 AWS Lambda(而不是后端 Lambda 函数)返回的状态代码。
$context.responseLatency 响应延迟(毫秒)。
$context.responseLength 响应负载长度。
$context.status 方法响应状态。