CloudWatch コンソールで API Gateway のログイベントを表示する
次のセクションでは、必要な前提条件を示し、CloudWatch コンソールで API Gateway のログイベントを表示する方法について説明します。
前提条件
-
API Gateway で API が作成済みであることが必要です。「API Gateway で REST API を開発する」の手順に従います。
-
API は、少なくとも 1 回、デプロイして呼び出す必要があります。「API Gateway で REST API をデプロイする」および「API Gateway で REST API を呼び出す」の手順に従います。
-
ステージで CloudWatch Logs を有効にする必要があります。「API Gateway で REST API の CloudWatch ログ記録を設定する」の手順に従います。
ログに記録された API リクエストや API レスポンスを CloudWatch コンソールで表示するには
CloudWatch コンソール (https://console.aws.amazon.com/cloudwatch/
) を開きます。 -
必要に応じて AWS リージョン を変更します。ナビゲーションバーから、AWS リソースがあるリージョンを選択します。詳細については、「リージョンとエンドポイント」を参照してください。
-
ナビゲーションペインで、[ログ]、[ロググループ] の順に選択します。
-
[ロググループ] 一覧で、"API-Gateway-Execution-Logs_{rest-api-id}/{stage-name}" という名前のロググループを選択します。
-
[ログストリーム] 一覧で、ログストリームを選択します。タイムスタンプを使用して、目的のログストリームを見つけることができます。
-
未加工のテキストを表示するには、[テキスト] を選択します。または、行ごとにイベントを表示するには、[行] を選択します。
重要
CloudWatch ではロググループやログストリームを削除することができますが、API Gateway の API のロググループやログストリームは手動で削除せず、API Gateway にそれらのリソースを管理させるようにしてください。ロググループまたはストリームを手動で削除すると、API のリクエストとレスポンスがログに記録されなくなる場合があります。その場合は、API のロググループ全体を削除して API を再デプロイしてくさい。これは、API Gateway によって API のデプロイ時に API ステージのロググループまたはログストリームが作成されるためです。
