Usage Plans

Prev Next

Available in Classic and VPC

After you create and deploy an API, you can control API usage through a Usage Plan.

Note

You can also set a default Usage Plan at the API stage.
For details, see Change Usage Plans in the My Products menu.

Usage Plans interface and list

The following provides a basic overview of the Usage Plans menu for using API Gateway.

apigw-apigw-2-3-list_ko

Component Description
① Menu name Current menu name. Number of usage plans in operation.
② Basic features Create a Usage Plan, view API Gateway details, refresh the page.
③ Post-creation features For active Usage Plans, Edit, Delete, Manage and connect to a stage.
④ Search bar Enter a Usage Plan name, then click i-apigateway-find to search for items.
⑤ Sort Set the number of Usage Plans displayed per list page.
⑥ Usage Plan list View the list of active Usage Plans
  • Usage Plan ID: The ID of the created Usage Plan (automatically assigned)
  • Usage Plan name: The name of the Usage Plan specified at creation
  • Description: The description entered when creating the Usage Plan
  • Request rate: The request rate configured when creating the Usage Plan (unit: requests/second)
  • Daily request limit:: The request limit configured when creating the Usage Plan (unit: requests/day)
  • Monthly request limit: The request limit configured when creating the Usage Plan (unit: requests/month)

Create a Usage Plan

To create a Usage Plan:

  1. In the NAVER Cloud Platform console, navigate to i_menu > Services > Application Services > API Gateway.
  2. Click Usage Plans.
  3. Click [Create Usage Plan].
  4. Enter the Usage Plan creation details, and then click [Next].
    • Name: Enter the name of the Usage Plan.
    • Description: Enter the description of the Usage Plan.
    • Request rate: Set the number of requests per second.
    • Request quota: Set daily and monthly API usage.
    • Usage is counted based on the start of a day/month.
    • Usage is counted based on the response code of the endpoint.
  5. Verify that the created Usage Plan appears in the Usage Plans list.
    • If the request rate and request limits are not configured correctly, the following message appears: Request rate is not set. or Request limit is not set. Edit the corresponding Usage Plan (see Edit Usage plans).

Edit Usage Plans

To edit a Usage Plan:

  1. In the NAVER Cloud Platform console, navigate to i_menu > Services > Application Services > API Gateway.
  2. Click Usage Plans.
  3. In the Usage Plans list, select the Usage Plan you want to edit, then click [Edit].
  4. On the Edit Usage Plan interface, update the settings, then click [Save].
  5. Verify that the Usage Plan has been updated in the Usage Plans list.

Delete a Usage Plan

To delete Usage Plan:

  1. In the NAVER Cloud Platform console, navigate to i_menu > Services > Application Services > API Gateway.
  2. Click Usage Plans.
  3. In the Usage Plans list, select the Usage Plan you want to delete, then click [Delete].
  4. In the delete confirmation popup, review the details, then click [Delete].

Connect and manage stages

You can connect the configured Usage Plan to a stage and manage it.

  • You can create the connection from either the Usage Plan interface or the Stage interface.
  • API usage for stages connected to a Usage Plan is managed collectively.

The following describes the list of stages connected to the Usage Plan:

apigw-apigw-2-3-stage-list_ko

Component Description
① Usage Plan Current settings
② Manage stage connections For the selected Usage Plan, Connect to a Stage and Disconnect from a Stage.
③ List List of stages connected to the Usage Plan
④ Sort Set the number of stages displayed per list page

Connect to a Stage

To connect a Usage Plan to a stage:

Note

To connect a Usage Plan to a stage, you must first create a stage for the API.
For details, see Create Stage.

  1. In the NAVER Cloud Platform console, navigate to i_menu > Services > Application Services > API Gateway.
  2. Click Usage Plans.
  3. In the Usage Plans list, select the Usage Plan you want to Stage, then click [Stage].
  4. On the connected stages list interface, click [Connect to Stage].
  5. In the Connect to Stage popup, select the stage to connect, then click [Add].
    • Product: Select the product that contains the stage you want to connect.
    • API: Select the API that contains the stage you want to connect.
    • Stage: Select the stage to connect.

Disconnect from a Stage

To disconnect a stage connected to a Usage Plan:

  1. In the NAVER Cloud Platform console, navigate to i_menu > Services > Application Services > API Gateway.
  2. Click Usage Plans.
  3. In the Usage Plans list, select the Usage Plan you want to disconnect, then click [Stage].
  4. On the connected stages list interface, select the stage you want to disconnect, then click [Delete].
  5. In the Disconnect from a Stage popup, review the details, then click [Delete].
    • The stage is disconnected and removed from the list.