API Gateway コンソールで使用量プランを作成、設定、テストする - Amazon API Gateway

API Gateway コンソールで使用量プランを作成、設定、テストする

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

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

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

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

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

  2. [使用プランの作成] で、以下の操作を行います。

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

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

    3. [スロットリングの有効化] を選択し、[レート] (例: 100) と [バースト] (例: 200) を設定します。

    4. [クォータを有効にする] を選択し、指定した時間間隔 (例: ) の制限の値 (例: 5000) を設定します。

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

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

    1. [API ステージの追加] を選択します。

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

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

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

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

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

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

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

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

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

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

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

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

    1. 既存のキーを使用する場合は、[API キーを使用量プランに追加] を選択します。

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

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

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

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

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

    注記

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

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

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

使用量プランをテストする

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

使用量プランをメンテナンスする

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

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

  1. API Gateway のメインナビゲーションペインで、[使用量プラン] を選択します。

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

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

  4. API キーを選択し、[使用量] を選択して、モニタリングしているプランから [Subscriber's Traffic (サブスクライバーのトラフィック)] を表示します。

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

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

    { "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. 使用量プランペインで、使用量プランウィンドウから [拡張] を選択します。

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

  4. [保存] を選択します。