All Products
Document Center

Dynamic Content Delivery Network:DescribeDcdnWafFilterInfo

Last Updated:May 21, 2024

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.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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
  • All Resources

Request parameters


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.

The language of the returned information. Valid values:

  • en: English
  • cn: Simplified Chinese

Response parameters


The ID of the request.

Contentobject []

The returned information.


The type of the protection policy. The value of this parameter is the same as that of the DefenseScenes parameter in the request.

Fieldsobject []

The information about the match condition.


The description of the match field. This parameter is not returned or is empty if no match fields are found.

Custom Header

The match field.

LogicalSymbolobject []

The information about the logical symbol.


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.

The logical symbol that is passed to the backend.


The tips that are displayed in the match item.

You can enter up to 50 tips. Press the Enter key.

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

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.

The logical symbol that is displayed in the Dynamic Content Delivery Network (DCDN) console.

Equal to one of multiple values.

The information about the regular expression.


The regular expression.


The error message returned when no items match the regular expression.

Specify this field.


Sample success responses


  "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 timeSummary of changesOperation
2023-11-21The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.