DescribeDcdnWafRules - Edge Security Acceleration - Alibaba Cloud Documentation Center

You can call DescribeDcdnWafRules to query the details of configured protection rules.

Operation description

Note

The call frequency for a single user is limited to 20 calls 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:DescribeDcdnWafRules

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
QueryArgs	string	No	The query conditions. This parameter is a JSON string. Note If you do not specify this parameter, all protection rules are queried.	{"RuleIds":"100001,200002"}
PageNumber	integer	No	The page number. The default value is 1. Valid values: 1 to 100000.	1
PageSize	integer	No	The number of protection rules to return on each page. The default value is 20. Valid values: an integer from 1 to 500.	20

QueryArgs details

Name	Type	Required	Example	Description
PolicyIds	string	No	10000001,10000100	The IDs of the mitigation policies. This is a term query. Separate multiple IDs with a comma (,).
RuleIds	string	No	100001,200002	The IDs of the protection rules. This is a term query. Separate multiple IDs with a comma (,).
RuleNameLike	string	No	rule_1	The name of the protection rule. This is a fuzzy query. The name can contain letters, digits, and underscores (_). The name can be up to 64 characters long.
DomainNames	string	No	example.com	The protected domain names. This is a term query. You can specify up to 50 domain names. Separate multiple domain names with a comma (,).
DefenseScenes	string	No	custom_acl	The type of the mitigation policy. This is a term query. Separate multiple types with a comma (,). The following scenarios are supported: `waf_group` (basic web protection), `custom_acl` (custom mitigation policy), and `whitelist` (whitelist).
RuleStatus	string	No	on	The status of the policy. Valid values: `on` (enabled) and `off` (disabled).
OrderBy	string	No	GmtModified	The field to use for sorting. Valid values: `GmtModified`, `RuleName`, `RuleStatus`, `RuleId`, and `PolicyId`.
Desc	Boolean	No	false	The sort order. Valid values: `true` (descending) and `false` (ascending). The default value is `false`.

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned on each page. This value is the same as the `PageSize` request parameter.	20
RequestId	string	The request ID.	66A98669-CC6E-4F3E-80A6-3014697B11AE
PageNumber	integer	The page number of the returned page. This value is the same as the `PageNumber` request parameter.	1
TotalCount	integer	The total number of protection rules.	121
Rules	array<object>	The details of the protection rules.
	object
RuleStatus	string	The status of the protection rule. This value is the same as the `RuleStatus` field in the `QueryArgs` request parameter.	on
DefenseScene	string	The type of the mitigation setting. This value is the same as the `DefenseScene` field in the `QueryArgs` request parameter.	custom_acl
PolicyId	integer	The ID of the mitigation policy.	200001
GmtModified	string	The time when the rule was last modified. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format and is displayed in UTC.	2021-12-29T17:08:45Z
RuleId	integer	The ID of the protection rule.	100001
RuleName	string	The name of the protection rule.	rule_1
RuleConfig	string	The configuration details of the protection rule.	{"action":"monitor","actionExternal":"{}","ccStatus":1,"conditions":[{"key":"URL","opValue":"eq","targetKey":"request_uri","values":"/example"},{"key":"Header","opValue":"eq","subKey":"trt","targetKey":"header.trt","values":"3333"}],"effect":"service","name":"aaa333","origin":"custom","ratelimit":{"interval":5,"status":{"code":404,"count":2,"stat":{"mode":"count","value":2.0}},"target":"remote_addr","threshold":2,"ttl":1800}}

Examples

Success response

JSON format

{
  "PageSize": 20,
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "PageNumber": 1,
  "TotalCount": 121,
  "Rules": [
    {
      "RuleStatus": "on",
      "DefenseScene": "custom_acl",
      "PolicyId": 200001,
      "GmtModified": "2021-12-29T17:08:45Z",
      "RuleId": 100001,
      "RuleName": "rule_1",
      "RuleConfig": "{\"action\":\"monitor\",\"actionExternal\":\"{}\",\"ccStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"eq\",\"targetKey\":\"request_uri\",\"values\":\"/example\"},{\"key\":\"Header\",\"opValue\":\"eq\",\"subKey\":\"trt\",\"targetKey\":\"header.trt\",\"values\":\"3333\"}],\"effect\":\"service\",\"name\":\"aaa333\",\"origin\":\"custom\",\"ratelimit\":{\"interval\":5,\"status\":{\"code\":404,\"count\":2,\"stat\":{\"mode\":\"count\",\"value\":2.0}},\"target\":\"remote_addr\",\"threshold\":2,\"ttl\":1800}}\n"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.