このトピックでは、API Gatewayアクセスログのフィールドについて説明します。
フィールド | 説明 |
apiGroupUid | APIが属するグループのID。 |
apiGroupName | APIが属するグループの名前。 |
apiUid | API ID。 |
apiName | API 名。 |
apiStageUid | APIが呼び出された環境のID。 |
apiStageName | 環境名。 |
httpMethod | APIリクエストで使用されたHTTPメソッド。 |
パス | APIのリクエストパス。 |
domain | API呼び出しに使用されたドメイン名。 |
statusCode | HttpStatusCode |
errorMessage | 返されたエラーメッセージ。 |
appId | APIの呼び出しに使用されたアプリケーションのID。 |
appName | APIの呼び出しに使用されたアプリケーションの名前。 |
clientIp | API呼び出しを開始したクライアントのIPアドレス。 |
例外 | APIのバックエンドサービスによって返された特定のエラーメッセージ。 |
exchangeTimestamp | リクエストリンクのI/Oポイント。
|
providerAliUid | APIを提供するアカウントのID。 |
region | APIが存在するリージョン。たとえば、cn-hangzhouは、中国 (杭州) リージョンを示します。 |
requestHandleTime | APIリクエストがAPI Gatewayによって受信されたUTCの時点。 |
requestId | リクエスト ID。 IDはグローバルに一意です。 |
requestSize | リクエストサイズ 単位：バイト |
responseSize | 応答サイズ。 単位：バイト |
serviceLatency | バックエンドリソースへのアクセスに費やされた合計時間。 合計時間には、リソースへの接続を要求するために消費された時間、接続を確立するために消費された時間、およびバックエンドサービスを呼び出すために消費された時間が含まれます。 単位：ミリ秒。 |
errorCode | X500ERなどのエラーコード。 |
requestProtocol | クライアントが要求を送信するために使用するプロトコル。 有効な値: HTTP、HTTPS、およびWS。 |
instanceId | APIが属するAPI GatewayインスタンスのID。 |
initialRequestId | APIが別のAPIを呼び出す場合 (たとえば、API-2を呼び出すAPI-1) 、initialRequestIdを使用して、API-1のリクエストIDをAPI-2のログに記録します。 |
clientNonce | クライアントから開始されたリクエストのX-Ca-Nonceヘッダー。 |
requestQueryString | クライアントから開始されたリクエストのqueryString。 このフィールドは専用インスタンス専用です。 |
requestHeaders | クライアントから開始されたリクエストのヘッダーの内容。 このフィールドは専用インスタンス専用です。 |
requestBody | クライアントから送信されたリクエストの本文。 ボディの長さは最大1,024バイトです。 このフィールドは専用インスタンス専用です。 |
responseHeaders | APIレスポンスのヘッダーの内容。 このフィールドは専用インスタンス専用です。 |
responseBody | 応答の内容。 応答は、1,024バイトまでの長さを含むことができる。 このフィールドは専用インスタンス専用です。 |
consumerAppKey | リクエストで使用されたAppKey。 |
totalLatency | APIリクエストの合計レイテンシ。 単位：ミリ秒。 |
customTraceId | エンドツーエンドログのtraceId。 |
jwtClaims | JSON webトークン (JWT) クレーム。 クレームはグループレベルで設定できます。 |
plugin | リクエストと関連するコンテキストによってヒットしたプラグイン。 |