WAF Filter Conditions Reference via GetWafFilter - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Retrieves the match engine information for a specified site at a specific WAF phase. This information defines how WAF detects and processes different types of network requests.

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

get

*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
Phase	string	No	The WAF phase for which to query the match engine information.	http_bot
Target	string	No	The value target that defines the application target of the match engine.	characteristics
Type	string	No	The rule type.	http_custom_cc

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
Filter	object	The match engine configuration information.
Phase	string	The WAF phase for processing requests.	http_bot
Target	string	The value target of the match engine.	characteristics
Type	string	The rule type.	http_custom_cc
Fields	array<object>	The list of match fields and their properties.
	array<object>	The match field properties.
Enable	boolean	Indicates whether the current plan supports this match field.	false
MinPlan	string	The minimum plan that supports this match field. This parameter is returned only when the current plan does not support the match field.	high
Label	string	The display label of the match field.	Header
Key	string	The internal parameter key of the match field.	http.request.headers
Sub	boolean	Indicates whether the match field contains subfields.	true
SubTip	string	The hint for users on how to enter subfield values.	e.g. Content-Type
Selector	object	The selector object that defines how to select the match field.
Kind	string	The kind of the selector, such as whether it is used to select data items.	data
Data	array<object>	The list of selectable data when the selector kind is data.
	object	The selectable data item when the selector kind is data.
Label	string	The display label of the selectable data.	China
Value	string	The parameter value of the selectable data.	CN
Logics	array<object>	The list of logic operator properties that define the logical conditions used for matching.
	array<object>	The logic operator properties applicable to the match field.
Enable	boolean	Indicates whether the current plan supports this match operator.	false
MinPlan	string	The minimum plan that supports this match operator. This parameter is returned only when the current plan does not support the match operator.	high
Symbol	string	The internal parameter key of the match operator.	eq
Operator	string	The display label of the match operator.	Does not equal
Negative	boolean	Indicates whether the match result is negated.
Type	string	The value type. Valid values: integer: integer integer_slice: integer array string: string string_slice: string array	string
Kind	string	The value input type. Valid values: select:single: single-select input box select:multi: multi-select input box input:single: single input box input:multi: multi input box	input:single
Attributes	integer	The configurable attributes, such as whether the match is case-sensitive.	1
Tip	string	The input hint that helps users provide valid values required by the rule.	e.g. image/jpeg
Validator	object	The validator object that defines the validation rules for values.
Length	WafQuotaInteger	The length limit of the value.
Pattern	string	The regular expression pattern for string validation.	^example$
Range	WafQuotaInteger	The numeric range for number validation.
ErrMsg	string	The error message returned when validation fails.	Enter a valid expression

Examples

Success response

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Filter": {
    "Phase": "http_bot",
    "Target": "characteristics",
    "Type": "http_custom_cc",
    "Fields": [
      {
        "Enable": false,
        "MinPlan": "high",
        "Label": "Header",
        "Key": "http.request.headers",
        "Sub": true,
        "SubTip": "e.g. Content-Type",
        "Selector": {
          "Kind": "data",
          "Data": [
            {
              "Label": "China",
              "Value": "CN"
            }
          ]
        },
        "Logics": [
          {
            "Enable": false,
            "MinPlan": "high",
            "Symbol": "eq",
            "Operator": "Does not equal",
            "Negative": false,
            "Type": "string",
            "Kind": "input:single",
            "Attributes": 1,
            "Tip": "e.g. image/jpeg",
            "Validator": {
              "Length": {
                "Equal": 1,
                "GreaterThan": 1,
                "GreaterThanOrEqual": 1,
                "LessThan": 1,
                "LessThanOrEqual": 1
              },
              "Pattern": "^example$",
              "Range": {
                "Equal": 1,
                "GreaterThan": 1,
                "GreaterThanOrEqual": 1,
                "LessThan": 1,
                "LessThanOrEqual": 1
              },
              "ErrMsg": "Enter a valid expression"
            }
          }
        ]
      }
    ]
  }
}

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.