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

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

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

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

デフォルトの使用プランへの移行

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

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

使用プランの作成

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

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

  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. [Save] を選択します。

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

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

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

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

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

    5. [Next] を選択します。

     API 使用量プランのエンティティ
  4. プランにキーを追加するには、[Usage Plan API Keys] ペインで、以下の操作を行います。

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

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

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

    4. この使用プランに他の既存の API キーを追加する必要がある場合は、この手順を繰り返してください。

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

    注記

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

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

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

使用プランをテストする

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

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

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

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

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

  2. 中央のセカンダリナビゲーションペインで、使用プランのリストから使用プランを選択します。

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

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

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

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

    Copy
    { "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] を選択します。