DescribeDcdnWafFilterInfo - Edge Security Acceleration - Alibaba Cloud Documentation Center

Call DescribeDcdnWafFilterInfo to query the match fields, logical operators, and match content available for custom mitigation policies.

Operation description

Note

The maximum number of calls that can be made by a single user is 20 per second.

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

dcdn:DescribeDcdnWafFilterInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DefenseScenes	string	No	The types of mitigation settings. Separate multiple types with commas (,). The following scenarios are supported: waf_group: basic web protection custom_acl: custom mitigation policies whitelist: whitelist Note If you do not specify this parameter, information for all types is returned.	custom_acl
Language	string	Yes	The language of the response. Valid values: en (default): English cn: Simplified Chinese	cn

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	153ca2cd-3c01-44be-204c-64dbc6c88630
Content	array<object>	The queried information.
	object
DefenseScene	string	The type of the mitigation setting. This is the same as the DefenseScene request parameter.	custom_acl
Fields	array<object>	Information about the match conditions.
	object
ExtendField	string	An extended tip for the match field. If this parameter is empty or not returned, no extended field is available.	自定义Header
MatchField	string	The match field.	Header
LogicalSymbol	array<object>	The logical operator.
	object
Type	string	The number of match content entries that you can specify. Valid values: multi: You can specify multiple match content entries. single: You can specify only one match content entry. none: You cannot specify any match content.	multi
Symbol	string	The logical operator that is passed to the backend.	match-one
Tip	string	The tip that is displayed for the match content.	可以输入多个，最多50个，按回车键确认
Attributes	integer	The configurable properties. This is a bit field variable. For more information, see the following table. Example: 1 (binary 00000001) indicates that you can enable case sensitivity but not stream matching. 3 (binary 00000011) indicates that you can enable both case sensitivity and stream matching. Bit (from low to high) - Description 1 - Case sensitivity 2 - Stream matching	1
MaxLength	integer	The maximum number of match content entries that you can specify. The value of this parameter varies based on the value of Type: If Type is set to multi, this parameter indicates the maximum number of entries. If Type is set to single, the value of this parameter is 1. If Type is set to none, the value of this parameter is 0.	50
Description	string	The logical operator displayed in the console.	等于多值之一
Regexp	object	The regular expression.
Pattern	string	The regular expression.	^\S+$
ErrMsg	string	The error message returned if the content does not match the regular expression.	字段不能为空

Examples

Success response

JSON format

{
  "RequestId": "153ca2cd-3c01-44be-204c-64dbc6c88630",
  "Content": [
    {
      "DefenseScene": "custom_acl",
      "Fields": [
        {
          "ExtendField": "自定义Header",
          "MatchField": "Header",
          "LogicalSymbol": [
            {
              "Type": "multi",
              "Symbol": "match-one",
              "Tip": "可以输入多个，最多50个，按回车键确认",
              "Attributes": 1,
              "MaxLength": 50,
              "Description": "等于多值之一",
              "Regexp": {
                "Pattern": "^\\S+$",
                "ErrMsg": "字段不能为空"
              }
            }
          ]
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.