DescribeDcdnWafRule - Edge Security Acceleration - Alibaba Cloud Documentation Center

Operation description

Note

A single user can call this operation up to 20 times 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:DescribeDcdnWafRule

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RuleId	integer	Yes	The ID of the protection rule. Only one rule ID is supported.	1000001

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	66A98669-CC6E-4F3E-80A6-3014697B11AE
Rule	object	The information about the protection rule.
RuleStatus	string	The status of the protection rule. Valid values: on: enabled off: disabled	on
DefenseScene	string	The type of the mitigation policy. The following scenarios are supported: waf_group: basic web protection custom_acl: custom mitigation policies whitelist: whitelist	custom_acl
PolicyId	integer	The ID of the mitigation policy.	200001
GmtModified	string	The time when the rule 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	integer	The ID of the protection rule.	100001
RuleName	string	The name of the protection rule.	rule_1
RuleConfig	string	The configuration 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

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.