Log fields

Parameter

Description

apiGroupUid

The ID of the API group.

apiGroupName

The name of the API group.

apiUid

The ID of the API.

apiName

The name of the API.

apiStageUid

The environment ID.

apiStageName

The environment name.

httpMethod

The HTTP method used for the call.

path

The request path.

domain

The domain name used for the call.

statusCode

The HTTP status code.

errorMessage

The error message.

appId

The caller's application ID.

appName

The caller's application name.

clientIp

The client's IP address.

exception

The specific error message from the backend service.

exchangeTimestamp

The timestamps of I/O events in the request lifecycle.

• FrontRequestStart: The time when API Gateway started to receive the client request.

• FrontRequestEnd: The time when API Gateway finished receiving the client request.

• BackendRequestStart: The time when API Gateway started to send the request to the backend service.

• BackendRequestEnd: The time when API Gateway finished sending the request to the backend service.

• BackendResponseStart: The time when API Gateway started to receive the response from the backend service.

• BackendResponseEnd: The time when API Gateway finished receiving the response from the backend service.

• FrontResponseStart: The time when API Gateway started to send the response to the client.

• FrontResponseEnd: The time when API Gateway finished sending the response to the client.

providerAliUid

The account ID of the API provider.

region

The region. Example: cn-hangzhou.

requestHandleTime

The request time (UTC).

requestId

The globally unique request ID.

requestSize

The request size in bytes.

responseSize

The response size in bytes.

serviceLatency

The total time spent accessing backend resources, including allocating connection resources, establishing the connection, and invoking the backend service. Unit: milliseconds.

errorCode

The error code. Example: X500ER.

requestProtocol

The client request protocol. Valid values: HTTP, HTTPS, and WS.

instanceId

The ID of the instance where the API service runs.

initialRequestId

If one API calls another (for example, API-1 calls API-2), this field records the request ID of the first call (API-1) in the log of the second call (API-2).

clientNonce

The X-Ca-Nonce header of the client request.

requestQueryString

The query string of the client request (dedicated instances only).

requestHeaders

The headers of the client request (dedicated instances only).

requestBody

The body of the client request, up to 1,024 bytes (dedicated instances only).

responseHeaders

The headers of the API response (dedicated instances only).

responseBody

The body of the API response, up to 1,024 bytes (dedicated instances only).

consumerAppKey

The AppKey of the API request.

totalLatency

The total latency of the API request in milliseconds.

customTraceId

The trace ID of the end-to-end log.

jwtClaims

The claims parsed from the JSON Web Token (JWT). You can configure this in the API group settings.

plugin

The list of plug-ins that matched the API request and their related context.