Rate Limiting
The Rate Limiting policy controls the rate of requests that a particular client can send to an API in a fixed amount of time.
Configuration
The properties that have to be configured to use the policy are described below.
Figure 1: Rate Limiting policy attributes
| Property | Description |
|---|---|
| Display Name | A name that distinctly identifies the policy. |
| Perform Action | Action to be performed by the RateLimiter (Right now the two options are NO_ACTION and BLOCK). |
| Monitoring Parameter | A client-based Rate Limiter needs an identity for each entity to identify themselves for controlling the rate. The developer of the API Project needs to choose the identity for monitoring. Parameters available now are:
|
| Rate Limiting Method | The mathematical function on which the Rate Limiter works. Methods available now are:
|
| Rate per interval | Number of requests allowed in a Fixed interval. |
| Fixed interval | Time interval for setting rate per interval (in milliseconds). |
| Cache map size | A cache is implemented at the server level to manage client-level rate limiting effectively. Requests will be processed faster for users who have more frequent requests. The cache is an LRU Cache. |
| Client subscription list | List the Client Subscription IDs (Application ID in the Client Suscription) of clients whose rate is to be limited. This property applies to the Monitoring Parameter "Client subscription". Example ClientSub_1, ClientSub_2 |
| Client IP list | List the IPs of clients whose rate is to be limited. This property applies to the Monitoring Parameter "IP". |
| Client ID list | List the Client IDs of clients whose rate is to be limited. This property applies to the Monitoring Parameter "Client". Example cl1@gmail.com, cli2@gmail.com |
Multiple values can be added for Client IP, Client ID, and Client subscription list separated by commas.