DocsICP FilingConsole
Documentation

DescribeDcdnWafGroup

Updated at:
Copy as MD
Product
My Favorites

Queries the details of a custom WAF rule group. Specific rules can be paginated.

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

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
Language

string

Yes

The language in which the response is returned. Valid values:

  • en: English.

  • zh: Chinese.

Valid values:

  • en :

    English.

  • zh :

    Chinese.

zh
Id

integer

Yes

The ID of the WAF rule group. You can call the DescribeDcdnWafGroups operation to query the ID.

1012
Scope

string

Yes

The scope of the rule group to query. Valid values:

  • in: Inside the rule group. Returns the rules within the rule group.

  • out: Outside the rule group. Returns the rules that are in the full ruleset but not in the rule group.

Valid values:

  • in :

    Inside the rule group.

  • out :

    Outside the rule group.

in
QueryArgs

string

No

The query conditions. The value is a JSON-serialized string. Format:

QueryArgs={"PolicyIds":"Range of protection policy IDs","RuleIds":"Range of protection rule IDs","RuleNameLike":"Protection rule name","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 by default.

{"RiskLevel":"","ProtectionType":"","ApplicationType":"","RuleIdLike":""}
PageNumber

integer

No

The page number. Default value: 1.

1
PageSize

integer

No

The number of entries per page. Default value: 20.

20

Response elements

Element

Type

Description

Example

object

The request ID.

RequestId

string

The request ID.

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

integer

The ID of the custom WAF rule group.

1012
Name

string

The name of the WAF rule group.

test
TemplateId

integer

The template ID.

1012
Subscribe

string

Specifies whether subscription is enabled. Valid values:

  • on: Enabled.

  • off: Disabled.

on
TotalCount

integer

The total number of filtered rules.

16
Rules

array<object>

The rule struct.

object

The rule struct.

GmtModified

string

The time when the rule was modified.

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

integer

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 rule. Valid values:

  • 0: High risk.

  • 1: Medium risk.

  • 2: Low risk.

2
ProtectionType

integer

The protection type. Valid values:

  • 11: SQL injection

  • 12: Cross-site scripting (XSS)

  • 13: Code execution

  • 14: CRLF

  • 15: Local file inclusion (LFI)

  • 16: Remote file inclusion (RFI)

  • 17: Webshell

  • 19: Cross-site request forgery

  • 20: Other

  • 21: SEMA

11
ApplicationType

integer

The application type. Valid values:

  • 0: Common

  • 1: WordPress

  • 2: DedeCMS

  • 3: Discuz!

  • 4: PHPCMS

  • 5: ECShop

  • 6: ShopEx

  • 8: Drupal

  • 8: Joomla

  • 9: Metinfo

  • 10: Struts2

  • 11: Spring Boot

  • 12: JBoss

  • 13: WebLogic

  • 14: WebSphere

  • 15: Tomcat

  • 16: Elasticsearch

  • 18: ThinkPHP

  • 19: Fastjson

  • 20: ImageMagick

  • 21: PHPWind

  • 22: phpMyAdmin

  • 23: Resin

  • 24: IIS

  • 99: Others

1
CveId

string

The CVE ID.

CVE-2021-22945
CveUrl

string

The CVE URL.

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

integer

The page number.

1
PageSize

integer

The number of entries per page. Default value: 20.

20

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.