Amazon API Gateway
開発者ガイド

API Gateway コンソールで使用量プランを作成、設定、およびテストします。

使用量プランを作成する前に、該当する API キーがセットアップされていることを確認します。詳細については、「API Gateway コンソールを使用して API キーをセットアップする」を参照してください。

このセクションでは、API Gateway コンソールを使って使用量プランを作成、使用するための方法ついて説明します。

API をデフォルトの使用量プランへ移行 (必要な場合)

使用量プラン機能が展開された 2016 年 8 月 11 日以降に API Gateway の使用を開始した場合は、サポートされているすべてのリージョンで自動的に使用量プランが有効になっています。

それ以前に API Gateway の使用を開始した場合は、デフォルトの使用量プランへの移行が必要な場合もあります。選択したリージョンで使用量プランを初めて使用する前に、使用量プランの有効化オプションが表示されます。このオプションを有効化すると、既存の API キーに関連付けられた一意の API ステージすべてに、デフォルトの使用量プランが作成されます。デフォルトの使用量プランでは最初にスロットリングやクォータ制限が設定されていません。API キーと API ステージの関連付けは使用量プランにコピーされます。API は以前と同じように動作します。ただし、ApiKey stageKeys プロパティを使用する代わりに、API キー (UsagePlanKey 経由) を含む、指定した API ステージの値 (apiId および stage) に関連付けるために、UsagePlan apiStages プロパティを使用する必要があります。

すでにデフォルトの使用量プランに移行済みか確認するには、get-account CLI コマンドを使用します。使用量プランが有効になっている場合は、コマンド出力で features リストに "UsagePlans" のエントリが含まれます。

次のように AWS CLI を使用して、デフォルトの使用量プランに API を移行することもできます。

AWS CLI を使用してデフォルトの使用量プランに移行する

  1. CLI コマンド: update-account を呼び出します。

  2. cli-input-json パラメーターには次の JSON を使用します。

    [ { "op": "add", "path": "/features", "value": "UsagePlans" } ]

使用プランの作成

次の手順は、使用プランを作成する方法を説明します。

使用プランを作成するには

  1. Amazon API Gateway メインナビゲーションペインで、[Usage Plans] を選択して、[Create] を選択します。

  2. [Create Usage Plan] で、以下の操作を行います。

    1. [Name] に、プランの名前を入力します (例: Plan_A)。

    2. [Description] に、プランの説明を入力します。

    3. [Enable throttling] を選択し、[Rate] (例: 100) と [Burst] (例: 200) を設定します。

    4. [Enable quota] を選択し、指定した時間間隔 (例: Month) の制限 (例: 5000) を設定します。

    5. [次へ] を選択します。

     API 使用量プランのエンティティ
  3. プランにステージを追加するには、[Associated API Stages] ペインで、以下の操作を行います。

    1. [Add API Stage] を選択します。

    2. [API] ドロップダウンリストから、API (例: PetStore) を選択します。

    3. [Stage] ドロップダウンリストから、ステージ (例: Stage_1) を選択します。

    4. チェックマークのアイコンを選択して保存します。

     API ステージの追加
  4. メソッドスロットリングを設定するには、以下を実行します。

    1. [Configure Method Throttling (メソッドスロットリングの設定)] を選択します。

    2. [Add Resource/Method (リソース/メソッドの追加)] を選択します。

    3. [Resource (リソース)] ドロップダウンメニューからリソースを選択します。

    4. [Method (メソッド)] ドロップダウンメニューからメソッドを選択します。

    5. [Rate (requests per second) (レート – 1 秒あたりのリクエスト)] (例: 100) および [Burst (バースト)] (例: 200) を設定します。

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

    7. [Close] を選択します。

  5. プランにキーを追加するには、[API Keys (API キー)] タブで以下の操作を行います。

    1. 既存のキーを使用する場合は、[Add API Key to Usage Plan] を選択します。

    2. [Name] に追加するキーの名前 (例: MyFirstKey) を入力します。

    3. チェックマークのアイコンを選択して保存します。

    4. 必要に応じて、前述の手順を繰り返して、他の既存の API キーをこの使用量プランに追加します。

     API 使用量プランのエンティティ

    注記

    または、新しい API キーを作成して使用プランに追加する場合は、[Create API Key and add to Usage Plan (API キーを作成して使用プランに追加)] を選択し、手順に従います。

    注記

    API キーを複数の使用量プランと関連付けることができます。使用量プランを複数のステージと関連付けることができます。ただし、指定された API キーを API の各ステージの 1 つの使用量プランにのみ関連付けることができます。

  6. 使用プランの作成を終了するには、[Done] を選択します。

  7. 使用プランに API ステージを追加する場合は、[Add API Stage] を選択して、前述の手順を繰り返します。

使用プランをテストする

使用プランをテストするには、AWS SDK、AWS CLI、または Postman などの REST API クライアントを使用できます。 使用プランのテストに Postman を使用する例については、「使用プランのテスト」を参照してください。

使用量プランのメンテナンス

使用量プランのメンテナンスには、特定の期間の使用されたクォータおよび残りのクォータのモニタリング、および、必要に応じて、指定された量の残りのクォータの拡張が含まれます。次の手順は、クォータを監視し拡張する方法を説明します。

使用されたクォータおよび残りのクォータを監視するには

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

  2. 使用量プランのリストから使用量プランを選択します。

  3. 指定したプラン内から [API Keys] を選択します。

  4. API キーを選択し、[Usage] を選択して、モニタリングしているプランから [Subscriber's Traffic] を表示します。

  5. 必要に応じて、[Export] を選択し、[From] 日付および [To] 日付を選択して、エクスポートデータの形式 [JSON] または [CSV] を選択した後に、[Export] を選択します。

    次の例では、エクスポートされたファイルの例を示します。

    { "thisPeriod": { "px1KW6...qBazOJH": [ [ 0, 5000 ], [ 0, 5000 ], [ 0, 10 ] ] }, "startDate": "2016-08-01", "endDate": "2016-08-03" }

    この例の使用状況データは、API キー (px1KW6...qBazOJH) によって識別される、2016 年 8 月 1 日から 2016 年 8 月 3 日の、API クライアントの毎日の使用状況データです。 それぞれの毎日の使用状況データは使用されたクォータおよび残りのクォータを表示します。 この例では、サブスクライバは割り当てられたクォータをまだ使用していないため、API 所有者または管理者は残りのクォータを 3 日目に 5000 から 10 に削減しました。

残りのクォータを拡張するには

  1. 前述の手順のステップ 1 – 3 を繰り返します。

  2. 使用量プランペインで、使用量プランウィンドウから [Extension (拡張)] を選択します。

  3. [Remaining] リクエストクォータの数を入力します。

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