All Products
Search
Document Center

Edge Security Acceleration:DescribeDcdnWafGroup

Last Updated:Feb 26, 2025

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
dcdn:DescribeDcdnWafGroupget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LanguagestringYes

The language of the response. Valid values:

  • en: English.
  • zh: Chinese.
zh
IdlongYes

The ID of the WAF rule group. You can query the ID by calling the DescribeDcdnWafGroups operation.

1012
ScopestringYes

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
QueryArgsstringNo

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\":\"\"}
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 20.

20

Response parameters

ParameterTypeDescriptionExample
object

The request ID.

RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE73368
Idlong

The ID of the custom WAF rule group.

1012
Namestring

The name of the WAF rule group.

test
TemplateIdlong

The ID of the template.

1012
Subscribestring

Indicates whether to enable subscription. Valid values:

  • on:
  • off
on
TotalCountinteger

The total number of rules that are filtered out.

16
Rulesarray<object>

The configurations of the rule.

RuleItemobject
GmtModifiedstring

The time when the rule was modified.

2021-12-29T17:08:45Z
Idlong

The ID of the custom WAF rule.

100001
Namestring

The name of the WAF rule.

test
Descriptionstring

The description of the WAF rule.

OK
RiskLevelinteger

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
ProtectionTypeinteger

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
ApplicationTypeinteger

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
CveIdstring

The Common Vulnerabilities and Exposures (CVE) ID of the related vulnerability.

CVE-2021-22945
CveUrlstring

The CVE link.

https://nxx.nxxx.gov/vuln/detail/CVE-2022-XXXX
PageNumberinteger

The page number of the page returned.

1
PageSizeinteger

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.