DescribeApisecProtectionResources API Reference for WAF - Web Application Firewall - Alibaba Cloud - Web Application Firewall

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

list

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID of the WAF instance. Note You can call the DescribeInstance operation to query instance ID of the WAF instance.	waf-cn-0xldbqt****
Resource	string	No	The name of the protected object.	cwaf-***-waf
PageNumber	integer	No	The page number to return when you perform a paged query. Default value: 1, which indicates the first page. For more information about paging, see the API reference.	1
PageSize	integer	No	The number of entries per page when you perform a paged query. Default value: 10, which indicates 10 entries per page. For more information about paging, see the API reference.	10
ApisecStatus	integer	No	The global switch for API security.	1
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
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object	The response.
TotalCount	integer	The total number of entries returned.	5
RequestId	string	The request ID.	2EFCFE18-78F8-5079-B312-07***48B
Data	array<object>	The list of protected objects.
	object	The information about the protected object.
ApisecStatus	integer	The global switch for API security.	1
Resource	string	The protected object.	cwaf-***-waf
ReportStatus	integer	The status of the compliance review switch.	1
TraceStatus	integer	The status of the tracing audit switch.	0

Examples

Success response

JSON format

{
  "TotalCount": 5,
  "RequestId": "2EFCFE18-78F8-5079-B312-07***48B",
  "Data": [
    {
      "ApisecStatus": 1,
      "Resource": "cwaf-***-waf",
      "ReportStatus": 1,
      "TraceStatus": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.