DescribeDcdnWafGroups - Dynamic Content Delivery Network

Queries custom Web Application Firewall (WAF) rule groups.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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 Resources is 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:DescribeDcdnWafGroups	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Language	string	No	The language of the response. Valid values: en: English zh: Chinese	zh
QueryArgs	string	No	The query conditions. The value is a string in the JSON format. Format: `QueryArgs={"PolicyIds":"IDs of protection policies","RuleIds":"IDs of the protection rules","RuleNameLike":"Names of the protection rule","DomainNames":"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. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 20.	20

Response parameters

Parameter	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	integer	The number of WAF rule groups.	16
WafGroups	object []	The list of WAF rule groups.
GmtModified	string	The time when the WAF rule group was modified.	2020-04-12 22:25:11
Id	long	The ID of the custom WAF rule group.	30000156
Name	string	The name of the WAF rule.	DCDN-test-operation-reports-1
RuleCount	integer	The number of WAF rules.	452
TemplateId	long	The ID of the template.	1012
Subscribe	string	Indicates whether to enable subscription. Valid values: on off	on
Policies	object []	The policy that is associated with the WAF rule group.
Id	long	The ID of the policy.	30000165
Name	string	The name of the policy.	wasm-testmaster
Type	string	The type of the policy. Valid values: custom: a custom policy default: the default policy	default
PageNumber	integer	The page number of the returned page. Default value: 1.	1
PageSize	integer	The number of entries to return on each page. Default value: 20.	20

Examples

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation

No change history