Creating a Plan
You must have the API Gateway's manage packages and plans functional privilege assigned to perform this task.
You can create a Plan from the Manage packages and plans page.
![*](icon_task_xpe.png)
To create a plan
1. Click Packages in the title navigation bar.
2. Click Create in the Manage packages and plans section.
3. Select Plan.
4. Click Create.
5. Provide the following information in the Basic information section:
Field | Description |
Name | Name of the plan. |
Version | Version assigned for the plan. |
Description | A brief description for the plan. |
Icon | An icon that is displayed for the plan. Click Browse and select the required image to be displayed as the icon for the plan. The icon size should not be more than 100 KB. |
You can save the plan at this point and add the pricing and traffic optimization configurations at a later time.
6. Click Continue to Pricing.
Alternatively, click Pricing in the left navigation pane.
7. Provide the following information in the Pricing section:
Field | Description |
Cost | Specifies the cost for the plan. |
Terms | Specifies the terms of conditions for the pricing. |
License | Specifies the license information. |
You can save the plan at this point and provide traffic optimization configurations at a later time.
8. Click Continue to Quality of Service.
Alternatively, click Rate limits in the left navigation pane.
9. Click + Add Rule.
10. Provide the following information in the Create Rule section:
Field | Description |
Maximum request count | Specifies the maximum number of requests handled. Value provided should be an integer. |
Interval | Specifies the value for the interval for which the maximum request count is handled. Value provided should be an integer. |
Interval unit | Specifies the unit of measurement of the time interval. For example: minutes, seconds, and so on |
Violation message | Specifies the text that displays when the rule is violated. |
11. Click Ok.
This creates the rule and displays it in the Configured rules table. Click + Add rule to add more rules. You can edit or delete the rules by clicking the Edit and the Delete icons respectively.
At a later time, when this plan is applied to an API through a package, the rules that you configured for this plan are enforced on the applied API.
12. Click Quota and provide the following information in the Quota settings section.
Field | Description |
Maximum request quota | Specifies the maximum number of requests handled. Value provided should be an integer. |
Block on breach | When selected it specifies that the access to the API is blocked when there is a rule violation. By default, this option is not selected. |
Interval | Specifies the value for the interval for which the maximum request quota is handled. Value provided should be an integer. |
Interval unit | Specifies the unit of measurement of the interval. Example: minutes, seconds, and so on |
Violation message | Specifies the text that displays when the policy is violated. |
Notification settings | Specifies whether notifications are to be sent on rule violations. Enable the toggle button to enable the notifications and provide the following information: Notify after (in %): Provide a value which is a number. A notification is sent to the configured email IDs once the total request count reaches the % value as provided in the maximum quota value. Violation message: Provide the content of the mail that is sent to the configured email Ids once the quota request count reaches the limit specified. Email Ids: Provide email Id of the recipient to which notifications have to be sent of notification once the quota request count reaches the limit specified. Click ![](../yai-webhelp/images/add.png) . You can add multiple recipients. Note: The SMTP settings under Administrator settings > Destinations has to be provided for email to be sent. Send Digital Events: Sends the monitor events to the DES destination once the quota request count reaches the limit specified. Note: The Digital events settings has to be set under Administrator settings > Destination |
Note:
The number of requests within a Quota interval is retained in case of server crash or restart. For example, if the number of requests against a Quota is 10 and if the server restarts or crashes, the number of requests for that Quota is retained when the server is up.
13. Click Save.
The plan is created and listed in the list of plans.