All Products
Search
Document Center

Web Application Firewall:DescribeDefenseTemplateValidGroups

Last Updated:Apr 24, 2024

Queries the names of protected object groups for which a protection template can take effect.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the Web Application Firewall (WAF) instance.

Note You can call the DescribeInstance operation to query the ID of the WAF instance.
waf_v3prepaid_public_cn-nwy****pf0e
GroupNamestringNo

The name of the protected object group that you want to query.

group221
DefenseScenestringYes

The scenario in which the protection template is used.

  • waf_group: basic protection.
  • antiscan: scan protection.
  • ip_blacklist: IP address blacklist.
  • custom_acl: custom rule.
  • whitelist: whitelist.
  • region_block: region blacklist.
  • custom_response: custom response.
  • cc: HTTP flood protection.
  • tamperproof: website tamper-proofing.
  • dlp: data leakage prevention.
region_block
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

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

10
TemplateIdlongNo

The ID of the protection template.

12345
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfm2th****v6ay
RegionIdstringNo

The region in which the WAF instance is deployed. Valid values:

  • cn-hangzhou: Chinese mainland.
  • ap-southeast-1: outside the Chinese mainland.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

6EA4B39A-9C0C-5E57-993E-30B6****3AD0
TotalCountlong

The total number of entries returned.

27
Groupsarray

The names of the protected object groups.

string

The name of the protected object group.

group_example

Examples

Sample success responses

JSONformat

{
  "RequestId": "6EA4B39A-9C0C-5E57-993E-30B6****3AD0",
  "TotalCount": 27,
  "Groups": [
    "group_example"
  ]
}

Error codes

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