API Gateway のアクセスログ記録を設定するにはどうすればよいですか?

簡単な説明

API に対するリクエストの実行またはクライアントアクセスに関連する問題をデバッグするために、Amazon CloudWatch Logs をアクティブ化して API コールをログに記録することができます。

解決方法

開始する前に、次の事項が完了していることを確認してください。

• API をステージにデプロイしたこと。
• アカウントのログを CloudWatch に読み書きするための許可を API Gateway に付与したこと。

次に、アクセスログ記録をアクティブ化するには、API Gateway コンソールを使用して CloudWatch API ログ記録を設定する手順のステップ 1～5 と 7～8 (ステップ 6 はスキップします) に従います。

注: 本番稼働用 API の完全な API リクエストとレスポンスをログに記録しないことがベストプラクティスです。完全な API リクエストとレスポンスを記録することにより、機密データがログに記録される可能性があります。

これで、デバッグのために CloudWatch ログがアクティブ化されました。エラーを見つけるには、「CloudWatch Logs で API Gateway REST API エラーを見つけるにはどうすればよいですか?」を参照してください。

詳細については、「Monitoring REST API execution with Amazon CloudWatch metrics」(Amazon CloudWatch メトリクスを使用した REST API 実行のモニタリング) を参照してください。

---

関連情報

API Gateway REST API から「Lambda 関数の無効なアクセス許可」エラーをトラブルシューティングするにはどうすればよいですか？

CloudWatch Logs で API ゲートウェイから 5xx エラーを見つけるにはどうすればよいですか？

API ゲートウェイ REST API または WebSocket API のトラブルシューティングのために CloudWatch Logs を有効にするにはどうすればよいですか?