使用量プランを作成する前に、該当する 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 を使用してデフォルトの使用量プランに移行する
-
この CLI コマンド
update-account
を呼び出します。 -
cli-input-json
パラメータには次の JSON を使用します。[ { "op": "add", "path": "/features", "value": "UsagePlans" } ]
使用量プランを作成する
次の手順は、使用量プランを作成する方法を説明します。
使用量プランを作成するには
API Gateway コンソール (https://console.aws.amazon.com/apigateway
) にサインインします。 -
Amazon API Gateway のメインナビゲーションペインで、[使用量プラン] を選択し、次に [使用量プランの作成] を選択します。
-
[ロール名] に名前を入力します。
-
(オプション) [説明] に説明を入力します。
-
デフォルトでは、使用量プランではスロットリングが有効になっています。使用量プランの [レート] と [バースト] を入力します。[スロットリング] を選択してスロットリングをオフにします。
-
デフォルトでは、使用量プランでは一定期間のクォータが有効になっています。[リクエスト] には、使用プランの期間中にユーザーが実行できるリクエストの合計数を入力します。[クォータ] を選択してクォータを無効にします。
-
[使用量プランの作成] を選択します。
使用プランにステージを追加するには
-
使用プランを選択します。
-
[関連ステージ] タブの [ステージを追加する] を選択します。
-
[API] には API を選択します。
-
[ステージ] では、ステージを選択します。
-
(オプション) メソッドレベルのスロットリングをオンにするには、次の手順を実行します。
-
[メソッドレベルのスロットリング] を選択し、[メソッドを追加] を選択します。
-
[リソース] では、API からリソースを選択します。
-
[メソッド] では、API からメソッドを選択します。
-
使用量プランの [レート] と [バースト] を入力します。
-
-
[使用量プランに追加] を選択します。
使用プランにキーを追加するには
-
[関連付けられた API キー] で、[API キーを追加] を選択します。
-
-
既存のキーを使用プランに関連付けるには、[既存のキーを追加] を選択し、ドロップダウンメニューから既存のキーを選択します。
-
新しい API キーを作成するには、[新しいキーを作成して追加] を選択し、新しいキーを作成します。新しいキーの作成方法の詳細については、「API キーを作成する」を参照してください。
-
-
[API キーの追加] を選択します。
使用量プランをテストする
使用量プランをテストするには、AWS SDK、AWS CLI、または REST API クライアント (Postman など) を使用できます。使用量プランのテストに Postman
使用量プランをメンテナンスする
使用量プランのメンテナンスには、特定の期間の使用されたクォータおよび残りのクォータのモニタリング、および、必要に応じて、指定された量の残りのクォータの拡張が含まれます。次の手順は、クォータを監視する方法について説明しています。
使用されたクォータおよび残りのクォータを監視するには
API Gateway コンソール (https://console.aws.amazon.com/apigateway
) にサインインします。 -
API Gateway のメインナビゲーションペインで、[使用量プラン] を選択します。
-
使用プランを選択します。
-
[関連付けられた API キー] タブを選択すると、各キーの期間に残っているリクエスト数が表示されます。
-
(オプション) [使用量データのエクスポート] を選択し、[開始] と [終了] を選択します。次に、エクスポートするデータ形式として [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 に削減しました。
次の手順は、クォータを修正する方法を説明します。
残りのクォータを拡張するには
API Gateway コンソール (https://console.aws.amazon.com/apigateway
) にサインインします。 -
API Gateway のメインナビゲーションペインで、[使用量プラン] を選択します。
-
使用プランを選択します。
-
[関連付けられた API キー] タブを選択すると、各キーの期間に残っているリクエスト数が表示されます。
-
API キーを選択し、[使用期限の延長を付与] を選択します。
-
[残りリクエスト] クォータの数を入力します。使用プランの期間中は、残りのリクエストを増やすことも、残りのリクエストを減らすこともできます。
[クォータの更新] を選択します。