DescribeDcdnWafGroups - Edge Security Acceleration - Alibaba Cloud Documentation Center

You can call DescribeDcdnWafGroups to query a list of custom Web Application Firewall (WAF) rule groups.

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:DescribeDcdnWafGroups

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Language	string	No	The language of the response. Valid values: en: English. This is the default value. zh: Chinese.	zh
QueryArgs	string	No	The query conditions in a JSON-serialized string. The format is as follows: `QueryArgs={"PolicyIds":"Range of mitigation policy IDs","RuleIds":"Range of rule IDs","RuleNameLike":"Rule name","DomainNames":"Protected domain names","DefenseScenes":"waf_group","RuleStatus":"on","OrderBy":"GmtModified","Desc":"false"}` Note If you do not set this parameter, all mitigation rules are queried.	{"RuleIds":"100001,200002"}
PageNumber	integer	No	The page number. The default value is 1.	1
PageSize	integer	No	The number of entries per page. The default value is 20.	20

Response elements

Element	Type	Description	Example
	object	The ID of the request.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	integer	The total number of WAF rule groups.	16
WafGroups	array<object>	The list of WAF rule groups.
	object
GmtModified	string	The time when the rule group was last modified.	2020-04-12 22:25:11
Id	integer	The ID of the custom WAF rule group.	30000156
Name	string	The name of the WAF rule group.	DCDN-test-operation-reports-1
RuleCount	integer	The number of rules in the group.	452
TemplateId	integer	The template ID.	1012
Subscribe	string	Indicates whether subscription is enabled. Valid values: on: Subscription is enabled. off: Subscription is disabled.	on
Policies	array<object>	The policies to which the WAF rule group is attached.
	object
Id	integer	The policy ID.	30000165
Name	string	The policy name.	wasm-testmaster
Type	string	The type of the policy. Valid values: custom: a custom policy. default: a default policy.	default
PageNumber	integer	The page number. The default value is 1.	1
PageSize	integer	The number of entries per page. The default value is 20.	20

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 16,
  "WafGroups": [
    {
      "GmtModified": "2020-04-12 22:25:11",
      "Id": 30000156,
      "Name": "DCDN-test-operation-reports-1",
      "RuleCount": 452,
      "TemplateId": 1012,
      "Subscribe": "on",
      "Policies": [
        {
          "Id": 30000165,
          "Name": "wasm-testmaster",
          "Type": "default"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.