DescribeApisecProtectionResources - - Alibaba Cloud Documentation Center

Queries the list of protected objects to which API security policies are applied.

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:DescribeApisecProtectionResources	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region in which the Web Application Firewall (WAF) instance is deployed. Valid values: cn-hangzhou: Chinese mainland ap-southeast-1: outside the Chinese mainland	cn-hangzhou
InstanceId	string	No	The ID of the WAF instance. Note You can call the DescribeInstance operation to query the ID of the WAF instance.	waf-cn-0xldbqt****
Resource	string	No	The name of the protected object.	cwaf-***-waf
PageNumber	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries per page. Default value: 10.	10
ApisecStatus	integer	No	The switch of the API security module.	1
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	long	The total number of entries returned.	5
RequestId	string	The request ID.	2EFCFE18-78F8-5079-B312-07***48B
Data	array<object>	The protected objects.
data	object	The protected object.
ApisecStatus	long	The switch of the API security module.	1
Resource	string	The protected object.	cwaf-***-waf
ReportStatus	long	The switch of the compliance check feature.	1
TraceStatus	long	The switch of the tracing and auditing feature.	0

Examples

Sample success responses

JSONformat

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

Error codes

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