Usage Plans

Available in Classic and VPC

After creating and distributing API, API usage amount can be controlled using a usage plan.

Usage plan screen and list

The following describes the basics of Usage Plan menu for API Gateway use.

Field	Description
① Menu name	Name of the menu currently being viewed, number of usage plans in operation
② Basic features	Create Usage Plan, view detailed API Gateway information, page refresh
③ Post-creation features	Edit, Delete and Stage Connection and Management of usage plan in operation
④ Search window	Enter the usage plan name, and then click to search
⑤ Sort	Set the number of usage plans to display on list page
⑥ Usage Plan list	Checks usage plan list in operation Usage Plan ID: ID of created usage plan (automatic designation) Usage Plan Name: name of usage plan set during usage plan creation Description: description of usage plan entered during usage plan creation Request Rate: request rate (unit: items/sec) set during usage plan creation Daily Request Process Limit: limit of request processing (unit: items/day) set during usage plan creation Monthly Request Process Limit: limit of request processing (unit: items/month) set during usage plan creation

Create Usage Plan

The following describes how to create a usage plan.

1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
2. Click Usage Plans menu.
3. Click the [Create Usage Plan] button.
4. Enter the usage plan information, and then click the [Save] button.
   • Name: Enter the name for the usage plan.
   • Description: Enter the description for the usage plan.
   • Request Rate (Rate): Set the number of requests per second.
   • Request Quota: Set daily and monthly API usage amount.
   • Usage amount is counted based on the start of a day/month.
   • Usage amount is counted based on response codes of the endpoint.
5. Check whether the created usage plan is displayed on the Usage Plan list.
   • If the Request Rate and Request Process Limit are not properly set, Request Rate is not set. or Request Process Limit is not set. message will be displayed. Edit the corresponding usage plan. (Refer to (Edit Usage Plan)

Edit Usage Plan

The following describes how to edit a usage plan.

1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
2. Click Usage Plans menu.
3. Click to select the usage plan to edit from the Usage Plan list, and then click the [Edit] button.
4. Edit information from the Edit Usage Plan screen, and then click the [Save] button.
   • For more information on each item, refer to Create Usage Plan.
5. Check whether the usage plan is edited on the Usage Plan list.

Delete Usage Plan

The following describes how to delete a usage plan.

1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
2. Click Usage Plans menu.
3. Click to select the usage plan to delete from the Usage Plan list, and then click the [Delete] button.
4. Check the details in the Delete Confirmation pop-up window, and then click the [Delete] button.

Stage connection and management

The set usage plan can be connected to a stage and be managed.

• Connection can be made from the usage plan and stage screens.
• Integrated management is applied to API usage amount of the stage connected to a usage plan.

The following describes the list of stages connected to a usage plan.

Stage Connection

The following describes how to connect a usage plan to a stage.

1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
2. Click Usage Plans menu.
3. Click to select the usage plan from the Usage Plan list, and then click the [Stage] button.
4. Click to select the stage from the Connected Stage list screen, and then click the [Connect Stage] button.
5. Select the storage to connect from the Connect Stage pop-up window, and then click the [Add] button.
   • Product: Select product with the stage to connect.
   • API: Select API with the stage to connect.
   • Stage: Select stage to connect.

Disconnect Stage

The following describes how to disconnect the stage connected to a usage plan.

1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
2. Click Usage Plans menu.
3. Click to select the usage plan to disconnect from the Usage Plan list, and then click the [Stage] button.
4. Click to select the stage to disconnect from the Connected Stage list screen, and then click the [Delete] button.
5. Check the details in the Disconnect Stage pop-up window, and then click the [Delete] button.
   • Stage connection is disconnected and is deleted from the list.