DescribeDefenseTemplateValidGroups - Web Application Firewall

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

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

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
yundun-waf:DescribeDefenseTemplateValidGroups	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	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
GroupName	string	No	The name of the protected object group that you want to query.	group221
DefenseScene	string	Yes	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
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	10
TemplateId	long	No	The ID of the protection template.	12345
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm2th****v6ay
RegionId	string	No	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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	6EA4B39A-9C0C-5E57-993E-30B6****3AD0
TotalCount	long	The total number of entries returned.	27
Groups	array	The names of the protected object groups.
Group	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.

Change history

Change time	Summary of changes	Operation

No change history