リファレンス: ゲートウェイ ログ スキーマ
適用対象: すべての API Management レベル
この記事では、Azure API Management GatewayLogs リソース ログのスキーマ リファレンスを提供します。 ログ エントリには、上位の共通スキーマのフィールドも含まれています。
API Management のリソース ログの収集を有効にする方法については、「発行された API を監視する」の該当セクションを参照してください。
GatewayLogs のスキーマ
API 要求ごとに、次のプロパティがログに記録されます。
| プロパティ | タイプ | 説明 |
|---|---|---|
| ApiId | string | 現在の要求の API エンティティ識別子 |
| ApimSubscriptionId | string | 現在の要求のサブスクリプション エンティティ識別子 |
| ApiRevision | string | 現在の要求の API リビジョン |
| BackendId | string | 現在の要求のバックエンド エンティティ識別子 |
| BackendMethod | string | バックエンドに送信された要求の HTTP メソッド |
| BackendProtocol | string | バックエンドに送信された要求の HTTP プロトコル バージョン |
| BackendRequestBody | string | バックエンド要求本文 |
| BackendRequestHeaders | 動的 | バックエンドに送信される HTTP ヘッダーのコレクション |
| BackendResponseBody | string | バックエンド応答本文 |
| BackendResponseCode | INT | バックエンドから受信した HTTP 応答のコード |
| BackendResponseHeaders | 動的 | バックエンドから受信した HTTP ヘッダーのコレクション |
| BackendTime | long | バックエンドの I/O 全体 (接続バイト、送信バイト、受信バイト) に費やされたミリ秒数 |
| BackendUrl | string | バックエンドに送信された要求の URL |
| キャッシュ | string | 要求の処理における API Management キャッシュ使用の状態 (ヒット、ミス、なし) |
| CacheTime | long | API Management キャッシュの IO 全体 (接続バイト、送信バイト、受信バイト) に費やされたミリ秒数 |
| ClientProtocol | string | 受信要求の HTTP プロトコル バージョン |
| ClientTime | long | クライアントの I/O 全体 (接続バイト、送信バイト、受信バイト) に費やされたミリ秒数 |
| ClientTlsVersion | string | 要求を送信するクライアントによって使用される TLS のバージョン |
| エラー | 動的 | 要求の処理中に発生したエラーのコレクション |
| IsRequestSuccess | [bool] | 応答の状態コードが 2xx または 3xx の範囲内で HTTP 要求が完了 |
| LastErrorElapsed | long | ゲートウェイが要求を受信してからエラーが発生するまでの経過ミリ秒数 |
| LastErrorMessage | string | エラー メッセージ |
| LastErrorReason | string | エラーの理由 |
| LastErrorScope | string | エラーの原因となったポリシーを含んでいるポリシー ドキュメントのスコープ |
| LastErrorSection | string | エラーの原因となったポリシーを含んでいるポリシー ドキュメントのセクション |
| LastErrorSource | string | エラーの原因となったポリシー (または処理中の内部ハンドラー) の名前付け |
| Method | string | 受信要求の HTTP メソッド |
| OperationId | string | 現在の要求の操作エンティティ識別子 |
| ProductId | string | 現在の要求の製品エンティティ識別子 |
| RequestBody | string | クライアント要求本文 |
| RequestHeaders | 動的 | クライアントにより送信される HTTP ヘッダーのコレクション |
| RequestSize | INT | 要求の処理中にクライアントから受信したバイト数 |
| ResponseBody | string | ゲートウェイ応答本文 |
| ResponseCode | INT | クライアントに送信された HTTP 応答の状態コード |
| ResponseHeaders | 動的 | クライアントに送信される HTTP ヘッダーのコレクション |
| ResponseSize | INT | 要求の処理中にクライアントに送信されたバイト数 |
| TotalTime です | long | HTTP 要求全体に費やされたミリ秒数 (API Management によって受信された最初のバイトから、クライアントが折り返し受信した最後のバイトまで) |
| TraceRecords | 動的 | トレース ポリシーによって出力されるレコード |
| url | string | 受信要求の URL |
| UserId | string | 現在の要求のユーザー エンティティ識別子 |
次の手順
- API Management の API を監視する方法については、「発行された API を監視する」を参照してください
- Azure リソース ログの共通およびサービス固有のスキーマについて、さらに学習してください
- DeveloperPortalAuditLogs スキーマ リファレンス