文档

API网关

更新时间:

本文介绍API网关调用日志的字段详情。

日志项

描述

apiGroupUid

API的分组ID

apiGroupName

API分组名称

apiUid

API的ID

apiName

API名称

apiStageUid

API环境ID

apiStageName

API环境名称

httpMethod

调用的HTTP方法

path

请求的PATH

domain

调用的域名

statusCode

HttpStatusCode

errorMessage

错误信息

appId

调用者应用ID

appName

调用者应用名称

clientIp

调用者客户端IP

exception

后端返回的具体错信息

exchangeTimestamp

整个请求链路的IO时间点

  • FrontRequestStart:API网关开始接收到客户端请求的时间点

  • FrontRequestEnd:API网关完成接收客户端请求的时间点

  • BackendRequestStart:API网关开始向后端服务发起请求的时间点

  • BackendRequestEnd:API网关完成向后端服务发起请求的时间点

  • BackendResponseStart:API网关开始接收到后端服务响应的时间点

  • BackendResponseEnd:API网关完成接收后端服务响应的时间点

  • FrontResponseStart:API网关开始向客户端发送响应的时间点

  • FrontResponseEnd:API网关完成向客户端发送响应的时间点

providerAliUid

API提供者账户ID

region

区域,如:cn-hangzhou

requestHandleTime

请求时间,UTC

requestId

请求ID,全局唯一

requestSize

请求大小,单位:字节

responseSize

返回数据大小,单位:字节

serviceLatency

访问后端资源耗时总和,包括申请连接资源耗时,建立连接耗时,调用后端服务耗时,单位:毫秒

errorCode

错误码code,如:X500ER

requestProtocol

客户端请求协议:HTTP/HTTPS/WS

instanceId

API服务所在的网关实例ID

initialRequestId

API网关自调用时,例如API-1调用API-2 ,那么API-2的日志中会用initialRequestId来记录API-1的requestid。

clientNonce

客户端X-Ca-Nonce头

requestQueryString

客户端请求的queryString(仅专享实例)

requestHeaders

客户端请求的header内容(仅专享实例)

requestBody

客户端请求的body内容,最多1024个字节(仅专享实例)

responseHeaders

API响应的header内容(仅专享实例)

responseBody

API响应的response内容,最多1024个(仅专享实例)

consumerAppKey

API请求的appKey

totalLatency

API请求的总延迟,单位毫秒

customTraceId

全链路日志的traceId

jwtClaims

从JWT中解析出来的Claim,可以在分组上配置

plugin

API请求命中的插件列表及相关上下文