DescribeDefenseTemplateValidGroups - Web Application Firewall

Queries the names of protected object groups that have a pending protection template.

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

yundun-waf:DescribeDefenseTemplateValidGroups

list

*All Resource

*

acs:ResourceGroupId

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 to query.	group221
DefenseScene	string	Yes	The protection scenario. For more information, see the valid values for the DefenseScene parameter in CreateDefenseRule when DefenseType is set to template.	region_block
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	10
TemplateId	integer	No	The ID of the protection template.	12345
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm2th****v6ay

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	27
RequestId	string	The ID of the request.	6EA4B39A-9C0C-5E57-993E-30B6****3AD0
Groups	array	A list of protected object group names.
	string	The name of the protected object group.	group_example

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.