All Products
Search
Document Center

Edge Security Acceleration:ListWafRulesets

Last Updated:Nov 15, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

List WAF Rule Sets

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
esa:ListWafRulesetslist
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SiteIdlongNo

Site ID, which can be obtained by calling the ListSites interface.

1
SiteVersionintegerNo

Site version.

0
PhasestringNo

WAF operation phase, specifying the rule set phase to query.

http_bot
QueryArgsobjectNo

Query parameters, passed in JSON format, containing various filtering conditions.

NameLikestringNo

Fuzzy search for rule set name.

example
AnyLikestringNo

Fuzzy search for rule set ID, rule set name, rule ID, and rule name.

example
OrderBystringNo

Specify the column to sort by.

id
DescbooleanNo

Whether to sort in descending order.

PageNumberintegerNo

Page number, specifying the current page number for paginated queries.

1
PageSizeintegerNo

Page size, specifying the number of records per page for paginated queries.

20

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

Request ID.

36af3fcc-43d0-441c-86b1-428951dc8225
SiteUsagelong

Number of WAF rule sets used by the site in this WAF operation phase.

5
InstanceUsagelong

Number of WAF rule sets used by the instance in this WAF operation phase.

10
TotalCountlong

Total number of filtered records.

5
Rulesetsarray<object>

List of rule set information, containing detailed information about the rule sets.

Ruleobject

Rule set information

UpdateTimestring

Last modification time of the rule set.

2024-01-01T00:00:00Z
Idlong

ID of the WAF rule set.

10000001
Namestring

Name of the rule set.

example
Statusstring

Status of the rule set.

on
Phasestring

WAF operation phase.

http_bot
Typesarray

List of rule types.

Typestring

Rule type.

http_custom_cc
Targetstring

Protection target type in http_bot.

web
Fieldsarray

List of match objects.

Fieldstring

Match object.

http.request.headers
PageNumberinteger

Current page number.

1
PageSizeinteger

Page size.

20

Examples

Sample success responses

JSONformat

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "SiteUsage": 5,
  "InstanceUsage": 10,
  "TotalCount": 5,
  "Rulesets": [
    {
      "UpdateTime": "2024-01-01T00:00:00Z",
      "Id": 10000001,
      "Name": "example",
      "Status": "on",
      "Phase": "http_bot",
      "Types": [
        "http_custom_cc"
      ],
      "Target": "web",
      "Fields": [
        "http.request.headers"
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 20
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.The specified parameter is invalid.
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-25The Error code has changedView Change Details
2024-09-18The Error code has changedView Change Details