Usage Plans

Prev Next

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

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

参考

APIの Satgeでも基本 Usage Planを設定できます。
詳細は My Productsメニューの Usage Plans変更をご参照ください。

Usage Plan画面とリスト

API Gatewayを利用するための Usage Plansメニューの基本的な説明は、次の通りです。

apigw-apigw-2-3-list_ko

領域 説明
① メニュー名 現在確認中のメニュー名、運用中の Usage plan数
② 基本機能 Usage Plan作成、API Gateway詳細情報の確認、ページの更新
③ 作成後の機能 運用中の Usage Planの変更、削除、Stageに関連付けして管理
④ 検索ボックス Usage Planの名前を入力した後、i-apigateway-findをクリックして項目を検索
⑤ ソート リストのページごとに表示する 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クラウドプラットフォームコンソールでi_menu > 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クラウドプラットフォームコンソールでi_menu > 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クラウドプラットフォームコンソールでi_menu > 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リストについての説明は以下の通りです。

apigw-apigw-2-3-stage-list_ko

領域 説明
① Usage Plan 設定情報の情報
② Stage関連付けの管理 選択した Usage Planを Stageに関連付けと関連付けを解除
③ リスト Usage Planに関連付けられたリスト
④ ソート リストのページごとに表示する Stage数の設定

Stageの関連付け

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

参考

Usage Planを Stageに関連付けるには、先に当該 APIに Stageを作成する必要があります。
詳細は、Stage作成をご参照ください。

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