ListWafUsageOfRules - Query WAF rule usage | ESA API - Edge Security Acceleration

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:ListWafUsageOfRules

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	No	The site ID. You can call the ListSites operation to obtain the site ID.	1
InstanceId	string	No	The WAF instance ID. If this parameter is left empty, the API returns an empty result. We recommend that you always specify this parameter.	esa-site-b0wdsrlba3nk
Phase	string	No	The phase in which the WAF rule runs. This parameter is required. Common values: http_custom, http_ratelimit, http_anti_scan, http_bot, http_managed, http_whitelist, and http_threat_intelligence. Note Note: This parameter is required on the server side. If this parameter is not specified, the API returns InvalidParameter (400).	http_custom

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
Sites	array<object>	The list of site usage.
	object	The site usage details.
Id	integer	The site ID.	1
Name	string	The site name.	example.com
Usage	integer	The number of WAF rules or WAF rule sets that have been used.	1
BatchConfigUsage	integer	The number of rules or rule sets for the specified phase under instance-level batch configuration.	1
InstanceUsage	integer	The total number of rules or rule sets for the instance under the specified phase, including both site-level and instance-level rules.	2

Examples

Success response

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Sites": [
    {
      "Id": 1,
      "Name": "example.com",
      "Usage": 1
    }
  ],
  "BatchConfigUsage": 1,
  "InstanceUsage": 2
}

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.