🔖

API Gatewayとバックエンドの疎通確認で時間を無駄にしないための手順書

2021/05/02に公開

API Gateway(HTTP API)の疎通確認は、段階ごとに進めないと混乱します。
リクエストがバックエンドに到達するまでと、各段階の調査方法をまとめました。

API Gateway → バックエンドのリクエスト解決順

普通にdigしてCNAMEレコードが返ってくるか確認してください。
ここで失敗していると、当然ですがそもそもAPIからレスポンスが返ってきません。

疎通確認のため、API GatewayのStageからEnable CloudWatch Logs を必ず有効にしてください。
CloudFormationで設定している場合は TracingEnabled: true で有効になります。

その後、普通に curl や Postman でAPIにアクセスしてください。
私がよく遭遇するエラーは以下のとおりです。

API Gatewayの指定したリソースが存在しない場合に表示されます。
要するにURLやメソッドが間違ってるか、API Gatewayのリソースポリシーが間違っています。

{
    "message": "Missing Authentication Token"
}

メソッドリクエストの実行に失敗した時によく遭遇するエラーは以下の通りです。

例えばAPI_KEYが間違っています。

{
    "message": "Forbidden"
}

メソッドリクエストの AuthorizerをIAMに指定している場合で、かつAWSのセッションが切れている場合です。

{
    "message": "The security token included in the request is invalid"
}

ここまでくれば、後は API Gateway自体の CloudWatch Logsでデバッグできるでしょう。

よくやらかすのはAPI GatewayにLambdaを実行する権限がない場合などです。