DescribeDcdnWafDefaultRules - Edge Security Acceleration

Calls the DescribeDcdnWafDefaultRules operation to query the default configurations of WAF rules.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
QueryArgs	string	No	The query conditions, which are a JSON-serialized string. Format: `QueryArgs={"DefenseScene":"anti_scan"}`	{"DefenseScene":"anti_scan"}

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A123425345
Content	array<object>	The rule struct.
	object
DefenseScene	string	The protection scenario. Valid values: waf_group: basic web protection. anti_scan: scan protection.	anti_scan
Rules	array<object>	The rule struct.
	object
Type	string	The rule type. Valid values: waf_group: basic web protection. high_frequency: blocks high-frequency scans. directory_traversal: blocks directory traversal attacks. scan_tools: blocks scanning tools.	waf_group
Name	string	The default name of the rule.	Default_WafGroup_Rule
Status	string	The default status of the rule. Valid values: on: The rule is enabled. off: The rule is disabled.	on
Config	string	The default configurations of the rule.	{"wafGroupIds":"1012"}
Action	string	The default action of the rule. Valid values: monitor: Monitor. deny: Deny. block: Block.	block

Examples

Success response

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A123425345",
  "Content": [
    {
      "DefenseScene": "anti_scan",
      "Rules": [
        {
          "Type": "waf_group",
          "Name": "Default_WafGroup_Rule",
          "Status": "on",
          "Config": "{\"wafGroupIds\":\"1012\"}",
          "Action": "block"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.