REST または HTTP API の API Gateway のデフォルトエンドポイントを非アクティブ化する方法を教えてください。

解決策

デフォルトのエンドポイントを非アクティブ化するには、API Gateway コンソール、AWS コマンドラインインターフェイス (AWS CLI)、または AWS CloudFormation を使用します。デフォルトのエンドポイントの非アクティブ化後、アップデートを有効にするにはステージを更新する必要があります。たとえば、デプロイメントを作成してステージにアタッチします。

注: AWS コマンドラインインターフェイス (AWS CLI) コマンドの実行中にエラーが発生した場合は、「AWS CLI で発生したエラーのトラブルシューティング」を参照してください。また、AWS CLI の最新バージョンを使用していることを確認してください。

API Gateway コンソール

REST API については、「REST API のデフォルトのエンドポイントを無効にする」の「AWS Management Console」タブを参照してください。HTTP API については、「HTTP API のデフォルトのエンドポイントを無効にする」の「AWS Management Console」タブを参照してください。

AWS CLI

REST API については、「REST API のデフォルトのエンドポイントを無効にする」の「AWS CLI」タブを参照してください。HTTP API については、「HTTP API のデフォルトのエンドポイントを無効にする」の「AWS CLI」タブを参照してください。

CloudFormation

REST API または HTTP API の CloudFormation テンプレートを更新して、DisableExecuteApiEndpoint パラメータを True に設定します。

重要: デフォルトのエンドポイント URL を使用して API を呼び出す場合、デフォルトのエンドポイントを非アクティブ化するとエラーが表示されます。REST API の場合は "403 Forbidden"、HTTP API の場合は "404 Not Found" というエラーが表示されます。

関連情報

API Gateway で REST API を呼び出す

API ゲートウェイからの HTTP 403 エラーをトラブルシューティングする方法を教えてください