DescribeApisecProtectionGroups - Web Application Firewall

Retrieves a list of active API security protection object groups.

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

list

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
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
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to query the ID of the current WAF instance.	waf_elasticity-cn-0xldbqt****
ResourceGroup	string	No	The name of the protected object group.	group1
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: 10.	10
ApisecStatus	integer	No	The API security detection switch.	1
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The result of the request.
TotalCount	integer	The total number of protected object groups.	8
RequestId	string	The request ID.	D7861F61-5B61-46CE-A47C-6B19****5EB0
Data	array<object>	The list of protected object groups.
	object	The information about the protected object group.
ApisecStatus	integer	The master switch for API security.	1
ReportStatus	integer	The compliance check switch.	0
ResourceGroup	string	The name of the protected object group.	group1
TraceStatus	integer	The traceability audit switch.	0

Examples

Success response

JSON format

{
  "TotalCount": 8,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19****5EB0",
  "Data": [
    {
      "ApisecStatus": 1,
      "ReportStatus": 0,
      "ResourceGroup": "group1",
      "TraceStatus": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.