This topic describes the fields of API Gateway access logs.
Field | Description |
apiGroupUid | The ID of the group to which the API belongs. |
apiGroupName | The name of the group to which the API belongs. |
apiUid | The API ID. |
apiName | The API name. |
apiStageUid | The ID of the environment in which the API was called. |
apiStageName | The environment name. |
httpMethod | The HTTP method that was used by the API request. |
path | The request path of the API. |
domain | The domain name that was used for the API call. |
statusCode | HttpStatusCode |
errorMessage | The returned error message. |
appId | The ID of the application that was used to call the API. |
appName | The name of the application that was used to call the API. |
clientIp | The IP address of the client that initiated the API call. |
exception | The specific error message that was returned by the backend service of the API. |
exchangeTimestamp | The I/O points in time in the request link.
|
providerAliUid | The ID of the account that provides the API. |
region | The region where the API resides, for example, cn-hangzhou, which indicates the China (Hangzhou) region. |
requestHandleTime | The time point in UTC at which the API request was received by API Gateway. |
requestId | The request ID. The ID is globally unique. |
requestSize | The request size. Unit: bytes. |
responseSize | The response size. Unit: bytes. |
serviceLatency | The total time consumed to access the backend resources. The total time includes the time consumed to request a connection to the resources, the time consumed to establish the connection, and the time consumed to call the backend service. Unit: milliseconds. |
errorCode | The error code, such as X500ER. |
requestProtocol | The protocol used by the client to send the request. Valid values: HTTP, HTTPS, and WS. |
instanceId | The ID of the API Gateway instance to which the API belongs. |
initialRequestId | If an API calls another API, for example, API-1 calls API-2, initialRequestId is used to record the request ID of API-1 in the logs of API-2. |
clientNonce | The X-Ca-Nonce header in the request initiated from the client. |
requestQueryString | The queryString in the request initiated from the client. This field is for dedicated instances only. |
requestHeaders | The header content in the request initiated from the client. This field is for dedicated instances only. |
requestBody | The body of the request sent by the client. The body can contain up to 1,024 bytes in length. This field is for dedicated instances only. |
responseHeaders | The header content of the API response. This field is for dedicated instances only. |
responseBody | The response content. The response can contain up to 1,024 bytes in length. This field is for dedicated instances only. |
consumerAppKey | The AppKey that was used in the request. |
totalLatency | The total latency of the API request. Unit: milliseconds. |
customTraceId | The traceId of the end-to-end log. |
jwtClaims | The JSON web token (JWT) claims. The claims can be configured at the group level. |
plugin | The plug-in hit by the request and the relevant context. |