Usage Plans
- 印刷する
- PDF
Usage Plans
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Classic/VPC環境で利用できます。
APIを作成、配布した後、Usage Plan(使用計画)でAPIの使用量を制御できます。
参考
APIのSatgeでも基本のUsage Planを設定できます。
詳細は、My ProductsメニューのUsage Plansの変更をご参照ください。
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の作成
Usage Planを作成する方法は以下のとおりです。
- NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
- Usage Plansメニューをクリックします。
- [Usage Planの作成] ボタンをクリックします。
- Usage Planの作成情報を入力して、[保存] ボタンをクリックします。
- 名前:Usage Plan名を入力
- 説明:Usage Planの説明を入力
- リクエスト処理量(Rate):1秒当たりのリクエスト数を設定
- リクエスト処理制限(Quota):日別、月別API使用量を設定
- 使用量は、日/月の初めを基準にカウントされます。
- エンドポイントのレスポンスコードに応じて使用量をカウントします。
- Usage plansリストで作成したUsage planが表示されるかどうかを確認します。
- リクエスト処理量とリクエスト処理限度が正しく設定されないと、リクエスト処理量が設定されていません、またはリクエスト処理限度が設定されていませんというメッセージが表示されます。 当該Usage Planを修正します(Usage plansの修正を参照)。
Usage Planの修正
Usage Planを修正する方法は以下のとおりです。
- NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
- Usage Plansメニューをクリックします。
- Usage Plansリストで修正するUsage Planをクリックして選択した後、[修正] ボタンをクリックします。
- Usage Planの修正画面で設定情報を修正して、[保存] ボタンをクリックします。
- 設定項目に関する説明は、Usage Planの作成をご参照ください。
- Usage plansリストでUsage planが修正されたかどうかを確認します。
Usage Planの削除
Usage Planを削除する方法は以下のとおりです。
- NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
- Usage Plansメニューをクリックします。
- Usage Plansリストで削除するUsage Planをクリックして選択した後、[削除] ボタンをクリックします。
- 削除確認ポップアップで内容を確認して、[削除] ボタンをクリックします。
Stageの関連付けと管理
設定したUsage PlanをStageに関連付けて管理できます。
- Usage PlanとStageの各画面から関連付けることができます。
- Usage Planに関連付けられたStageのAPIの使用量は統合管理されます。
Usage Planに関連付けたStageリストに関する説明は、以下のとおりです。
領域 | 説明 |
---|---|
① Usage Plan | 現在の設定情報 |
② Stageの関連付け管理 | 選択したUsage PlanをStageの関連付けと関連付けの解除 |
③ リスト | Usage Planに関連付けたリスト |
④ ソート | リストのページごとに表示するStage数の設定 |
Stageの関連付け
Usage PlanをStageに関連付ける方法は以下のとおりです。
参考
Usage PlanをStageに関連付けるには、先にAPIにStageを作成します。
詳細内容については、Stageの作成をご参照ください。
- NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
- Usage Plansメニューをクリックします。
- Usage Plansリストで、対象のUsage Planをクリックして選択した後、[Stage] ボタンをクリックします。
- 関連付けられたStageのリスト画面で、[Stageの関連付け] ボタンをクリックします。
- Stageの関連付けのポップアップで関連付けるStageを選択して、[追加] ボタンをクリックします。
- Product:関連付けるStageがあるProductを選択
- API:関連付けるStageがあるAPIを選択
- Stage:関連付けるStageを選択
Stageの関連付けの解除
Usage Planと関連付けられたStageの関連付けを解除する方法は、以下のとおりです。
- NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
- Usage Plansメニューをクリックします。
- Usage Plansリストで関連付けを解除するUsage Planをクリックして選択した後、[Stage] ボタンをクリックします。
- 関連付けられたStageのリスト画面で、関連付けを解除するStageをクリックして選択した後、[削除] ボタンをクリックします。
- Stageの関連付けの解除ポップアップで内容を確認して、[削除] ボタンをクリックします。
- Stageの関連付けが解除されて、リストから削除されます。
この記事は役に立ちましたか?