API Gateway インスタンスと、アクセス権限を付与した VPC 内のインスタンスとの間のネットワーク接続をテストできます。これにより、API デバッグ中に API 呼び出しの失敗を引き起こす可能性のあるネットワーク接続の問題を特定できます。このトピックでは、VPC アクセス権限付与の接続性テスト機能について説明し、接続性テストの失敗をトラブルシューティングするためのガイドを提供します。
VPC 権限付与
VPC アクセス権限付与は、API Gateway が VPC にデプロイしたビジネスサービスにアクセスできるようにするレコードを作成します。VPC アクセス権限付与を作成するときは、VPC ID、サービスを提供する CLB または ECS インスタンスのインスタンス ID、およびサービスポート番号を指定する必要があります。この情報はビジネスサービスを一意に識別し、API Gateway がそれにアクセスすることを許可します。詳細については、「VPC 内のリソースを API のバックエンドサービスとして使用する」をご参照ください。
接続性テストの実行
API Gateway コンソールにログインします。左側のナビゲーションウィンドウで、 を選択し、VPC アクセス権限付与を作成します。
[接続性のテスト] をクリックし、宛先の API Gateway インスタンスを選択します。
重要選択したインスタンスにアクセスの制御ポリシーが設定されていないことを確認してください。設定されている場合、接続性テストが失敗する可能性があります。
[テスト] をクリックします。選択した API Gateway インスタンスから、VPC アクセス権限付与で指定されたビジネスサービスへの接続テストが開始されます。テストが完了すると、結果がページに表示されます。
テストに合格
API Gateway インスタンスと VPC アクセス権限付与のサービス間のネットワークが接続されている場合、インスタンスのドロップダウンリストの前に緑色のチェックマークが表示されます。これは、接続性テストが成功したことを示します。
テストに失敗
接続性テストが失敗すると、プロンプトが表示されます。これは、API Gateway インスタンスと VPC アクセス権限付与のサービス間のネットワークが切断されていることを示します。テストが失敗した場合は、[トラブルシューティングガイド] をクリックし、プロンプトに従って問題をトラブルシューティングできます。
トラブルシューティングガイド
ネットワークが切断されている場合は、[トラブルシューティングガイド] をクリックしてポップアップウィンドウを開くことができます。このウィンドウには、トラブルシューティングプロセスをガイドするための一連のステップが表示されます。ポップアップウィンドウには、VPC アクセス権限付与で指定されたインスタンスタイプに応じて、CLB または ECS インスタンスのトラブルシューティングの手順が表示されます。プロンプトに従って問題をトラブルシューティングします。
トラブルシューティングのプロシージャは、次の 3 つのステップで構成されます。
VPC 権限付与情報が正しいかどうかを確認します。
VPC アクセス権限付与を作成するときは、VPC ID、インスタンス ID、およびサービスポートを指定する必要があります。このステップでは、対応するクラウドプロダクトのコンソールに移動して、入力した情報が正しいことを確認するように求められます。
ECS インスタンスのセキュリティグループ (または CLB インスタンスのブラックリストとホワイトリスト) を確認します。
VPC アクセス権限付与のインスタンスが、セキュリティグループが設定された ECS インスタンスである場合は、ECS コンソールに移動する必要があります。次に、プロンプトに従って、API Gateway インスタンスの出力 IP アドレスを ECS インスタンスのセキュリティグループのインバウンドポリシーに追加します。
VPC アクセス権限付与のインスタンスが、ホワイトリストベースのアクセスの制御ポリシーが設定された CLB インスタンスである場合は、API Gateway インスタンスの出力 IP アドレスを、対応するアクセスの制御ポリシーグループのアドレスエントリに追加する必要があります。
バックエンドサービスの起動ステータスを確認します。
このステップでは、バックエンドサービスの実行ステータスとヘルスステータスを確認する必要があります。VPC アクセス権限付与で指定されたインスタンスが ECS インスタンスの場合は、ECS インスタンスのヘルスステータスを確認します。インスタンスが CLB インスタンスの場合は、設定されたリスナーの実行ステータスとヘルスチェックステータスが [Normal] であることを確認します。ポートを確認するには、VPC 内の任意のサーバーにログインし、curl コマンドを実行して、設定された ECS または CLB インスタンスの対応するポートがリスニング状態にあるかどうかを確認します。