Queries the details of the protection rules that you configured.
Operation description
You can call this operation up to 20 times per second per account.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dcdn:DescribeDcdnWafRules | Read |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| QueryArgs | string | No | The query conditions. The value needs to be a JSON string in the following format: Note
If you do not specify this parameter, all protection rules are queried.
| {"RuleIds":"100001,200002"} |
| PageNumber | integer | No | The number of the page to return. Valid values: 1 to 100000. Default value: 1. | 1 |
| PageSize | integer | No | The number of protection rules to return per page. Valid values: integers from 1 to 500. Default value: 20. | 20 |
Fields in the QueryArgs parameter
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| PolicyIds | string | No | 10000001,10000100 | The IDs of protection policies. Separate multiple IDs with commas (,). Only exact search is supported. |
| RuleIds | string | No | 100001,200002 | The IDs of protection rules. Separate multiple IDs with commas (,). Only exact search is supported. |
| RuleNameLike | string | No | rule_1 | The name of the protection rule. Fuzzy search is supported. The name can be up to 64 characters in length and can contain letters, digits, and underscores (_). |
| DomainNames | string | No | example.com | The protected domain names. You can specify up to 50 domain names. Separate multiple domain names with commas (,). Only exact search is supported. |
| DefenseScenes | string | No | custom_acl | The types of the protection policies. Separate multiple types with commas (,). Only exact search is supported. Valid values: waf_group: basic web protection custom_acl: custom protection whitelist: IP address whitelist |
| RuleStatus | string | No | on | The status of the policy. Valid values: on off |
| OrderBy | string | No | GmtModified | The field that is used to sort query results. Valid values: GmtModified, RuleName, RuleStatus, RuleId, and PolicyId. |
| Desc | Boolean | No | false | The display order of the query results. Default value: false. true: reverse chronological order false: chronological order |
Response parameters
Examples
Sample success responses
JSONformat
{
"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}}"
}
]
}Error codes
For a list of error codes, visit the Service error codes.