DescribeDcdnWafFilterInfo - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the information about match conditions in a custom protection rule, such as the match fields, logical characters, and match content.

Operation description

You can call this operation up to 20 times per second per account.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DefenseScenes	string	No	The type of the protection policy. Separate multiple types with commas (,). Valid values: waf_group: basic web protection custom_acl: custom protection whitelist: IP address whitelist Note If you do not specify this parameter, all types are returned.	custom_acl
Language	string	Yes	The language of the returned information. Valid values: en: English cn: Simplified Chinese	cn

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	153ca2cd-3c01-44be-204c-64dbc6c88630
Content	array<object>	The returned information.
FilterInfo	object
DefenseScene	string	The type of the protection policy. The value of this parameter is the same as that of the DefenseScenes parameter in the request.	custom_acl
Fields	array<object>	The information about the match condition.
Field	object
ExtendField	string	The description of the match field. This parameter is not returned or is empty if no match fields are found.	Custom Header
MatchField	string	The match field.	Header
LogicalSymbol	array<object>	The information about the logical symbol.
Logic	object
Type	string	The number of match items. Valid values: multi: You can specify multiple match items. single: You can specify only a match item. none: no match items.	multi
Symbol	string	The logical symbol that is passed to the backend.	match-one
Tip	string	The tips that are displayed in the match item.	You can enter up to 50 tips. Press the Enter key.
Attributes	integer	The configurable attributes, which are bit-field variables that are shown in the following list. For example, 1(00000001) indicates that case sensitivity can be enabled and stream match cannot be enabled, and 3(00000011) indicates that case sensitivity and stream match can be enabled. Bit (low to high) - Description 1 - Case sensitivity 2 - Stream match	1
MaxLength	integer	The maximum number of match items that can be returned. The value of this parameter varies based on the value of the Type parameter. Valid values: If multi is returned for the Type parameter, the value of this parameter indicates the maximum number of match items. If single is returned for the Type parameter, the value of this parameter is 1. If none is returned for the Type parameter, the value of this parameter is 0.	50
Description	string	The logical symbol that is displayed in the Dynamic Content Delivery Network (DCDN) console.	Equal to one of multiple values.
Regexp	object	The information about the regular expression.
Pattern	string	The regular expression.	^\S+$
ErrMsg	string	The error message returned when no items match the regular expression.	Specify this field.

Examples

Sample success responses

JSONformat

{
  "RequestId": "153ca2cd-3c01-44be-204c-64dbc6c88630",
  "Content": [
    {
      "DefenseScene": "custom_acl",
      "Fields": [
        {
          "ExtendField": "Custom Header\n",
          "MatchField": "Header",
          "LogicalSymbol": [
            {
              "Type": "multi",
              "Symbol": "match-one",
              "Tip": "You can enter up to 50 tips. Press the Enter key.\n",
              "Attributes": 1,
              "MaxLength": 50,
              "Description": "Equal to one of multiple values.\n",
              "Regexp": {
                "Pattern": "^\\S+$",
                "ErrMsg": "Specify this field.\n"
              }
            }
          ]
        }
      ]
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-11-21	The response structure of the API has changed	View Change Details