DescribeDcdnWafGroup - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the details of a custom WAF rule group by page.

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
Language	string	Yes	The language of the response. Valid values: en: English. zh: Chinese.	zh
Id	long	Yes	The ID of the WAF rule group. You can query the ID by calling the DescribeDcdnWafGroups operation.	1012
Scope	string	Yes	The range of the rule group to be queried. in: Rules in the rule group are returned. out: Rules that are in the full rule set but are not in the rule group are returned.	in
QueryArgs	string	No	The query conditions. The value is 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.	{\"RiskLevel\":\"\",\"ProtectionType\":\"\",\"ApplicationType\":\"\",\"RuleIdLike\":\"\"}
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
Id	long	The ID of the custom WAF rule group.	1012
Name	string	The name of the WAF rule group.	test
TemplateId	long	The ID of the template.	1012
Subscribe	string	Indicates whether to enable subscription. Valid values: on: off	on
TotalCount	integer	The total number of rules that are filtered out.	16
Rules	array<object>	The configurations of the rule.
RuleItem	object
GmtModified	string	The time when the rule was modified.	2021-12-29T17:08:45Z
Id	long	The ID of the custom WAF rule.	100001
Name	string	The name of the WAF rule.	test
Description	string	The description of the WAF rule.	OK
RiskLevel	integer	The risk level of the resources that do not comply with the managed rule. Valid values: 1: high risk 2: medium risk 3: low risk	2
ProtectionType	integer	Protection type Valid values: 11: SQL injection 12: cross-site scripting (XSS) 13: code execution 14: carriage return line feeds (CRLF) 15: local file inclusion 16: remote file inclusion 17: webshells 19: cross-site request forgery 20: others 21: SEMA	11
ApplicationType	integer	The type of the application. Valid values: 0: Common 1: WordPress 2: DedeCMS 3: Discuz 4: PHP CMS 5: ECShop 6: ShopEX 7: Drupal 8: Joomla 9: MetInfo 10: Struts2 11: Spring Boot 12: JBoss 13: WebLogic 14: WebSphere 15: Tomcat 16: Elastic Search 18: ThinkPHP 19: Fastjson 20: ImageMagick 21: PHPWind 22: phpMyAdmin 23: Resin 24: IIS 99: Others	1
CveId	string	The Common Vulnerabilities and Exposures (CVE) ID of the related vulnerability.	CVE-2021-22945
CveUrl	string	The CVE link.	https://nxx.nxxx.gov/vuln/detail/CVE-2022-XXXX
PageNumber	integer	The page number of the page returned.	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",
  "Id": 1012,
  "Name": "test",
  "TemplateId": 1012,
  "Subscribe": "on",
  "TotalCount": 16,
  "Rules": [
    {
      "GmtModified": "2021-12-29T17:08:45Z",
      "Id": 100001,
      "Name": "test",
      "Description": "OK",
      "RiskLevel": 2,
      "ProtectionType": 11,
      "ApplicationType": 1,
      "CveId": "CVE-2021-22945",
      "CveUrl": "https://nxx.nxxx.gov/vuln/detail/CVE-2022-XXXX"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20
}

Error codes

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