DescribeDcdnWafRules - Edge Security Acceleration - Alibaba Cloud Documentation Center

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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: `QueryArgs={"PolicyIds":"The range of protection policy IDs","RuleIds":"The range of protection rule IDs","RuleNameLike":"The name of the protection rule","DomainNames":"The protected domain names","DefenseScenes":"waf_group","RuleStatus":"on","OrderBy":"GmtModified","Desc":"false"}`. 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

Parameter	Type	Description	Example
	object
PageSize	integer	The number of protection rules returned per page. The value of this parameter is the same as that of the PageSize parameter in the request.	20
RequestId	string	The ID of the request.	66A98669-CC6E-4F3E-80A6-3014697B11AE
PageNumber	integer	The page number of the returned page. The value of this parameter is the same as that of the PageNumber parameter in the request.	1
TotalCount	integer	The total number of protection rules.	121
Rules	array<object>	The information about the protection rule.
RuleItem	object
RuleStatus	string	The status of the protection rule. The value of this parameter is the same as that of the RuleStatus field in QueryArgst.	on
DefenseScene	string	The type of the protection policy. The value of this parameter is the same as that of the DefenseScene field in QueryArgst.	custom_acl
PolicyId	long	The ID of the protection policy.	200001
GmtModified	string	The time when the protection policy was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-12-29T17:08:45Z
RuleId	long	The ID of the protection rule.	100001
RuleName	string	The name of the protection rule.	rule_1
RuleConfig	string	The configuration information about 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

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.