GetWafQuota API Overview: WAF Quota Limits & Allocation - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Retrieves quota details for Web Application Firewall (WAF) resources. These quotas define the quantity limits of corresponding resources that a customer can use, such as managed rule groups, custom lists, custom response pages, and scenario-specific protection rules.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:GetWafQuota

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Paths	string	No	The paths of WAF quotas. Valid values: managed_rules_group: the quota for WAF managed rule groups. list: the quota for custom lists. page: the quota for custom response pages. scene_policy: the quota for scenario-specific protection rules.	page

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
Quota	object	The returned quota information.
ManagedRulesGroup	object	The quota information for WAF managed rule groups.
Enable	boolean	Whether the WAF managed rule group feature is enabled.
NumberTotal	WafQuotaInteger	The maximum number of WAF managed rule groups allowed.
List	object	The quota information for custom lists.
Enable	boolean	Whether the custom list feature is enabled.
NumberTotal	WafQuotaInteger	The maximum number of custom lists allowed.
NumberItemsTotal	WafQuotaInteger	The maximum number of items allowed across all custom lists.
NumberItemsPerList	WafQuotaInteger	The maximum number of items allowed per custom list.
Items	object	The quota for each item type in a custom list.
	object	The quota for an item in a custom list.
Enable	boolean	Whether the item type is enabled.
Value	WafQuotaString	The format constraints for the item type.
Page	object	The quota information for custom response pages.
Enable	boolean	Whether the custom response page feature is enabled.
NumberTotal	WafQuotaInteger	The maximum number of custom response pages allowed.
ContentTypes	object	The quota for each Content-Type in a custom response page.
	object	The quota for a Content-Type in a custom response page.
Enable	boolean	Whether the Content-Type is enabled.
ContentLength	WafQuotaInteger	The maximum content length for this Content-Type.
ScenePolicy	object	The quota information for scenario-specific protection rules.
Enable	boolean	Whether the scenario protection feature is enabled.
NumberTotal	WafQuotaInteger	The maximum number of scenario protection rules allowed.
Captcha	object	The quota information for CAPTCHA rules.
Enable	boolean	Whether captcha rules are enabled.
NumberTotal	WafQuotaInteger	The maximum number of captcha rules allowed.
SliderCaptchaPage	object	The quota information for slider CAPTCHA pages.
Enable	boolean	Whether slider captcha pages are enabled.
NumberTotal	WafQuotaInteger

Examples

Success response

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Quota": {
    "ManagedRulesGroup": {
      "Enable": false,
      "NumberTotal": {
        "Equal": 1,
        "GreaterThan": 1,
        "GreaterThanOrEqual": 1,
        "LessThan": 1,
        "LessThanOrEqual": 1
      }
    },
    "List": {
      "Enable": false,
      "NumberTotal": {
        "Equal": 1,
        "GreaterThan": 1,
        "GreaterThanOrEqual": 1,
        "LessThan": 1,
        "LessThanOrEqual": 1
      },
      "NumberItemsTotal": {
        "Equal": 1,
        "GreaterThan": 1,
        "GreaterThanOrEqual": 1,
        "LessThan": 1,
        "LessThanOrEqual": 1
      },
      "Items": {
        "key": {
          "Enable": false,
          "Value": {
            "Regexp": "^\\d+$"
          }
        }
      }
    },
    "Page": {
      "Enable": false,
      "ContentTypes": {
        "key": {
          "Enable": false
        }
      }
    },
    "ScenePolicy": {
      "Enable": false
    },
    "Captcha": {
      "Enable": false
    },
    "SliderCaptchaPage": {
      "Enable": false
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.