Usage Plans

Classic/VPC環境で利用できます。

APIを作成、配布した後、Usage Plan(使用計画)でAPIの使用量を制御できます。

Usage Plan画面とリスト

API Gatewayの利用のためのUsage Plansメニューの基本的な説明は以下のとおりです。

領域	説明
① メニュー名	現在確認中のメニュー名、運用中のUsage plan数
② 基本機能	Usage planの作成、API Gateway詳細情報の確認、ページの更新
③ 作成後の機能	運用中のUsage Planの修正、削除、Stageの関連付けと管理
④ 検索ウィンドウ	Usage Plan名を入力した後、をクリックして項目を検索
⑤ ソート	リストのページごとに表示するUsage Plan数の設定
⑥ Usage planのリスト	運用中のUsage planのリストを確認 Usage Plan ID：作成したUsage PlanのID(自動付与) Usage Plan名：Usage Planを作成する時に設定したUsage Planの名前 説明：Usage Planを作成する時に入力したUsage Planの説明 リクエスト処理量：Usage Planを作成する時に設定したリクエスト処理量(単位：件/秒) 日別リクエスト処理限度：Usage Planを作成する時に設定したリクエスト処理限度(単位：件/日) 月別リクエスト処理限度：Usage Planを作成する時に設定したリクエスト処理限度(単位：件/月)

Usage Planの作成

Usage Planを作成する方法は以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. Usage Plansメニューをクリックします。
3. [Usage Planの作成] ボタンをクリックします。
4. Usage Planの作成情報を入力して、[保存] ボタンをクリックします。
   • 名前：Usage Plan名を入力
   • 説明：Usage Planの説明を入力
   • リクエスト処理量(Rate)：1秒当たりのリクエスト数を設定
   • リクエスト処理制限(Quota)：日別、月別API使用量を設定
   • 使用量は、日/月の初めを基準にカウントされます。
   • エンドポイントのレスポンスコードに応じて使用量をカウントします。
5. Usage plansリストで作成したUsage planが表示されるかどうかを確認します。
   • リクエスト処理量とリクエスト処理限度が正しく設定されないと、リクエスト処理量が設定されていません、またはリクエスト処理限度が設定されていませんというメッセージが表示されます。 当該Usage Planを修正します(Usage plansの修正を参照)。

Usage Planの修正

Usage Planを修正する方法は以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. Usage Plansメニューをクリックします。
3. Usage Plansリストで修正するUsage Planをクリックして選択した後、[修正] ボタンをクリックします。
4. Usage Planの修正画面で設定情報を修正して、[保存] ボタンをクリックします。
   • 設定項目に関する説明は、Usage Planの作成をご参照ください。
5. Usage plansリストでUsage planが修正されたかどうかを確認します。

Usage Planの削除

Usage Planを削除する方法は以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. Usage Plansメニューをクリックします。
3. Usage Plansリストで削除するUsage Planをクリックして選択した後、[削除] ボタンをクリックします。
4. 削除確認ポップアップで内容を確認して、[削除] ボタンをクリックします。

Stageの関連付けと管理

設定したUsage PlanをStageに関連付けて管理できます。

• Usage PlanとStageの各画面から関連付けることができます。
• Usage Planに関連付けられたStageのAPIの使用量は統合管理されます。

Usage Planに関連付けたStageリストに関する説明は、以下のとおりです。

Stageの関連付け

Usage PlanをStageに関連付ける方法は以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. Usage Plansメニューをクリックします。
3. Usage Plansリストで、対象のUsage Planをクリックして選択した後、[Stage] ボタンをクリックします。
4. 関連付けられたStageのリスト画面で、[Stageの関連付け] ボタンをクリックします。
5. Stageの関連付けのポップアップで関連付けるStageを選択して、[追加] ボタンをクリックします。
   • Product：関連付けるStageがあるProductを選択
   • API：関連付けるStageがあるAPIを選択
   • Stage：関連付けるStageを選択

Stageの関連付けの解除

Usage Planと関連付けられたStageの関連付けを解除する方法は、以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. Usage Plansメニューをクリックします。
3. Usage Plansリストで関連付けを解除するUsage Planをクリックして選択した後、[Stage] ボタンをクリックします。
4. 関連付けられたStageのリスト画面で、関連付けを解除するStageをクリックして選択した後、[削除] ボタンをクリックします。
5. Stageの関連付けの解除ポップアップで内容を確認して、[削除] ボタンをクリックします。
   • Stageの関連付けが解除されて、リストから削除されます。