DescribeDefenseResourceGroups - Web Application Firewall

Retrieves information about protected object groups using pagination.

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

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 view the current WAF instance ID.	waf_v2_public_cn-wwo36****0i
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfmxc7lf****eq
GroupNameLike	string	No	The name of the protected object group that you want to query. Fuzzy query is supported.	demoGroupName
PageNumber	integer	No	The page number. Default value: 1, which indicates the first page.	1
PageSize	integer	No	The number of entries per page. Default value: 20, which indicates 20 entries per page.	20
GroupNames	string	No	The names of the protected object groups that you want to query. Separate multiple names with commas (,).	groupName1,groupName2
RegionId	string	No	The region in which the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	BFEC5C77-049B-5E88-A5B6-CB0C****B66E
TotalCount	integer	The total number of entries returned.	10
Groups	array<object>	The list of protected object groups.
	object	The protected object group.
Description	string	The description of the protected object group.	This is test description
GmtCreate	integer	The time when the protected object group was created. Unit: milliseconds.	1624343180000
GmtModified	integer	The most recent time when the protected object group was modified. Unit: milliseconds.	1701656305000
GroupName	string	The name of the protected object group.	apptest
ResourceList	string	The names of the protected objects that are added to the protected object group. Separate multiple protected objects with commas (,).	example02.aliyun-waf,example01.aliyun-waf

Examples

Success response

JSON format

{
  "RequestId": "BFEC5C77-049B-5E88-A5B6-CB0C****B66E",
  "TotalCount": 10,
  "Groups": [
    {
      "Description": "This is test description",
      "GmtCreate": 1624343180000,
      "GmtModified": 1701656305000,
      "GroupName": "apptest",
      "ResourceList": "example02.aliyun-waf,example01.aliyun-waf"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.