メニュー
Amazon API Gateway
開発者ガイド

API Gateway 使用量プランの作成と使用

API を作成し、テストして、デプロイすると、顧客への提供商品として拡張できます。 ビジネス要件および予算の制約に合った承認済みのリクエストレートとクォータで、指定した顧客に、選択した API へのアクセスを許可する使用プランを提供できます。

使用プランとは

使用量プランにより、個々のクライアント API キーに設定可能なスロットリングとクォータ制限がある、デプロイした 1 つ以上の API ステージにアクセスできます。 API 発信者は、API Gateway によって生成される、または外部ソースからインポートされる API キーで識別されます。 スロットリングは、各 API キーに適用されるリクエストレート制限を指示します。 クォータは、指定した期間内に送信された API キーを持つリクエストの最大数です。 個別の API メソッドを、使用プラン設定に基づく API キー認証を要求するように設定できます。 API ステージは、API 識別子とステージ名によって識別されます。

注記

スロットリングとクォータ制限は、使用プランのすべての API ステージについて集約される個々の API キーのリクエストに適用されます。

使用プランを設定する方法

以下の手順は、API 所有者として、顧客のために使用プランを設定する方法を示します。

使用プランを設定するには

  1. 1 つ以上の API を作成し、API キーを要求するメソッドを設定して、ステージに API をデプロイします。

  2. API キーを生成し、API を使用するアプリケーションの開発者 (顧客) にキーを配布します。

  3. 目的のスロットリングとクォータ制限を持つ使用プランを作成します。

  4. 使用プランに、選択した API ステージと API キーを関連付けます。

API の呼び出し元は、API へのリクエストの x-api-key ヘッダーで、割り当てられた API キーを指定する必要があります。

注記

API へのリクエストで API キーの認証を適用するために、個別の API メソッドを API キーの要求に設定する必要があります。 このように設定することで、使用プランに従って、受信する API キーの認証を実施することができます。

以下のセクションで、これらのタスクの詳細な手順を紹介します。

API Gateway コンソールを使用して API キーをセットアップする

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

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

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

API キーを設定するには、事前に API を設定し、それをステージにデプロイしている必要があります。

API Gateway コンソールを使用して API を作成し、デプロイする方法については、「API の作成」および「API のデプロイ」をそれぞれ参照してください。

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

次の手順では、API キーを要求する、API メソッドを設定する方法について説明します。

API キーを要求する API メソッドを設定するには

  1. AWS マネジメントコンソールにサインインして API Gateway コンソール (https://console.aws.amazon.com/apigateway/) を開きます。

  2. API Gateway メインナビゲーションペインで、[Resources] を選択します。

  3. [Resources] で、新しいメソッドを作成するか、既存のメソッドを選択します。

  4. [Method Request] を選択します。

  5. [Authorization Settings] セクションで、[API Key Required] に、[true] を選択します。

  6. チェックマークアイコンを選択して、設定を保存します。

  7. API をデプロイまたは再デプロイして要件を満たします。

API Key Required オプションを false に設定し、上記の手順を実行しない場合、そのメソッドに対しては API ステージに関連付けられている API キーが使用されません。

API キーの作成

使用プランで使用する API キーをすでに作成またはインポートした場合、この手順および次の手順を省略できます。

API キーを作成するには

  1. AWS マネジメントコンソールにサインインして API Gateway コンソール (https://console.aws.amazon.com/apigateway/) を開きます。

  2. API Gateway メインナビゲーションペインで、[API Keys] を選択します。

  3. [Actions] ドロップダウンメニューから、[Create API key] を選択します。

     使用プランの API キーの作成
  4. [Create API Key] で、以下の操作を行います。

    1. [Name] 入力フィールドに、API キー名 (例: MyFirstKey) を入力します。

    2. [Auto Generate] を選択してキー値を生成する API Gateway を取得するか、キーを手動で入力する [Custom] を選択します。

    3. [Save] を選択します。

     使用プランの API キーの作成
  5. 必要に応じてさらに API キーを作成するには、前述の手順を繰り返します。

API キーのインポート

次の手順は、使用プランで API キーをインポートする方法について説明します。

API キーをインポートするには

  1. メインナビゲーションペインで、[API Keys] を選択します。

  2. [Actions] ドロップダウンメニューから、[Import API keys] を選択します。

  3. カンマ区切りのキーファイルをロードするには、[Select CSV File] を選択します。 また、キーを手動で入力できます。 ファイル形式の詳細については、「API Gateway API キーファイルの形式」を参照してください。

     API 使用量プランのエンティティ
  4. エラーが発生した場合、[Fail on warnings] を選択してインポートを停止するか、[Ignore warnings] を選択して、エラーが発生した場合に、有効なキーエントリのインポートを継続します。

  5. 選択した API キーのインポートを開始するには、[Import] を選択します。

API キーをセットアップしたので、「create and use a usage plan」に進むことができます。