このトピックでは、API Gateway 呼び出しログのフィールドについて説明します。
フィールド | 説明 |
apiGroupUid | API が属するグループの ID。 |
apiGroupName | API が属するグループの名前。 |
apiUid | API ID。 |
apiName | API 名。 |
apiStageUid | API が呼び出された環境の ID。 |
apiStageName | 環境名。 |
httpMethod | API リクエストで使用された HTTP メソッド。 |
path | API のリクエストパス。 |
domain | API 呼び出しに使用されたドメイン名。 |
statusCode | HttpStatusCode |
errorMessage | 返されたエラーメッセージ。 |
appId | API の呼び出しに使用されたアプリケーションの ID。 |
appName | API の呼び出しに使用されたアプリケーションの名前。 |
clientIp | API 呼び出しを開始したクライアントの IP アドレス。 |
exception | API のバックエンドサービスによって返された特定のエラーメッセージ。 |
exchangeTimestamp | リクエストリンク内の I/O 時点。
|
providerAliUid | API を提供するアカウントの ID。 |
region | API が存在するリージョン。たとえば、cn-hangzhou は中国 (杭州) リージョンを示します。 |
requestHandleTime | API Gateway が API リクエストを受信した時点 (UTC)。 |
requestId | リクエスト ID。ID はグローバルに一意です。 |
requestSize | リクエストサイズ。単位: バイト。 |
responseSize | 応答サイズ。単位: バイト。 |
serviceLatency | バックエンドリソースへのアクセスに消費された合計時間。合計時間には、リソースへの接続をリクエストするために消費された時間、接続を確立するために消費された時間、およびバックエンドサービスを呼び出すために消費された時間が含まれます。単位: ミリ秒。 |
errorCode | エラーコード (X500ER など)。 |
requestProtocol | クライアントがリクエストの送信に使用したプロトコル。有効な値: HTTP、HTTPS、および WS。 |
instanceId | API が属する API Gateway インスタンスの ID。 |
initialRequestId | ある API が別の API を呼び出す場合 (たとえば、API-1 が API-2 を呼び出す場合)、initialRequestId は API-2 のログに API-1 のリクエスト ID を記録するために使用されます。 |
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 | リクエストによってヒットしたプラグインと関連するコンテキスト。 |