DescribeDcdnWafRule - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the details of a specified protection rule.

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
RuleId	long	Yes	The ID of the protection rule. You can specify only one ID in each request.	1000001

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	66A98669-CC6E-4F3E-80A6-3014697B11AE
Rule	object	The information about the protection rule.
RuleStatus	string	The status of the protection rule. Valid values: on off	on
DefenseScene	string	The type of the protection policy. Valid values: waf_group: basic web protection custom_acl: custom protection whitelist: IP address whitelist	custom_acl
PolicyId	long	The ID of the protection policy.	200001
GmtModified	string	The time when the scaling group was 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 configurations 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

Sample success responses

JSONformat

{
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "Rule": {
    "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

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	A parameter is set to an invalid value.

For a list of error codes, visit the Service error codes.