API Gateway REST API を使用して API キーをセットアップする - Amazon API Gateway

API Gateway REST API を使用して API キーをセットアップする

API キーを設定するには、以下の作業を行います。

  • API キーを要求するよう API メソッドを設定します。

  • リージョンの API 用に API キーを作成またはインポートします。

API キーを設定するには、事前に API を設定し、それをステージにデプロイしている必要があります。API キー値は、作成後に変更することはできません。

API の作成およびデプロイのための REST API コールについては、「restapi:create」および「deployment:create」をそれぞれ参照してください。

注記

考慮すべきベストプラクティスについては、「API キーと使用量プランのベストプラクティス」を参照してください。

メソッドで API キーを要求する

メソッドの API キーを要求するには、次のいずれかを実行します。

  • method:put を呼び出してメソッドを作成します。リクエストペイロードで apiKeyRequiredtrue に設定します。

  • method:update を呼び出して apiKeyRequiredtrue に設定します。

API キーの作成またはインポート

API キーを作成またはインポートするには、次のいずれかを実行します。

新しい API キーの値を変更することはできません。使用量プランを設定する方法については、「API Gateway CLI および REST API を使用してテスト使用量プランを作成、設定、およびテストする」を参照してください。