Get Rate Limiting Rules

Retrieve a list of all existing rate limiting Rules.

Request

Request-Line

GET /waap/v1.0/pbrStrategy/rateLimitings HTTP/1.1

Response

Response Body

Parameter	Type	Description
	Array	Array of Rate Limitings.

Object: Rate Limiting

Parameter	Type	Description
ruleId	Integer	Rule ID number for rate limiting.
name	String	Rule name for web access control.
description	String	The description can have 1-200 characters.
pathOperator	String	Matching operator used to evaluate the request path. Supported values: equal, notEqual, contain, notContain, beginsWith, notBeginsWith, endsWith, notEndsWith, regex, notMatchRegex, include, exclude.
pathPattern	String	The path pattern to be matched against the request URI. The interpretation depends on pathOperator. For example, when pathOperator is contain, the rule triggers if the request path contains this value.
keyType	String	The request attribute used for matching. Supported values: ip, fingerprint, userAgent, cookieId.
rateLimitType	String	Specifies the rate limiting mode. Supported values: rate (Queries per second) or timeWindow (Queries per Time Window).
rate	Integer	The maximum number of requests allowed per second. Only applicable when rateLimitType is rate.
burst	Integer	The maximum burst capacity above the configured rate. Only applicable when rateLimitType is rate.
windowUnit	String	The time unit of the rate limit window. Supported values: second, minute, hour. Only applicable when rateLimitType is timeWindow.
maxRequests	Integer	The maximum number of requests allowed within the specified time window. Only applicable when rateLimitType is timeWindow.
devType	String[]	Specifies the device types that the rule applies to. Supported values: pc, mac, mobile. Multiple device types can be selected.
triggeringProbability	Integer	The probability (in percentage) that the configured action will be triggered when the request matches the rule. Supported values: 100, 90, 80, 70, 60, 50, 40, 30, 20, 10.
autoListKey	String	The key type used by Auto-Web ACL to automatically control request access. Supported values: ip, fingerprint.
autoListDuration	Integer	The duration (in seconds) that the key will remain in the Auto-Web ACL once triggered. The valid range is 0 to 600000.
websites	Integer[]	List of website IDs the rule applies to.

Examples

Get Rate Limiting Rules

Request

GET /waap/v1.0/pbrStrategy/rateLimitings HTTP/1.1

Successful Response Body

[
    {
        "ruleId": 97,
        "name": "test111",
        "description": "test111",
        "pathOperator": "contain",
        "pathPattern": "/test",
        "keyType": "ip",
        "rateLimitType": "rate",
        "rate": 100,
        "burst": 100,
        "windowUnit": "minute",
        "maxRequests": 0,
        "devType": [
            "pc",
            "mac",
            "mobile"
        ],
        "triggeringProbability": 90,
        "autoListKey": "fingerprint",
        "autoListDuration": 111,
        "websites": []
    }
]