DescribeDefenseResourceGroups - Web Application Firewall

Performs a pagination query to retrieve the information about protected object groups.

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:DescribeDefenseResourceGroups	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_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 queries are supported.	demoGroupName
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	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: Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	BFEC5C77-049B-5E88-A5B6-CB0C****B66E
TotalCount	long	The total number of entries returned.	10
Groups	array<object>	The list of protected object groups.
Group	object
Description	string	The description of the protected object group.	This is test description
GmtCreate	long	The time when the protected object group was created. Unit: milliseconds.	1624343180000
GmtModified	long	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

Sample success responses

JSONformat

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

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