DescribeApisecStatistics - - Alibaba Cloud Documentation Center

Queries the statistics of API security-related risks and events.

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:DescribeApisecStatistics	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Region	string	No	The region in which the Web Application Firewall (WAF) instance is deployed. Valid values: cn (default): Chinese mainland. cn-hongkong: outside the Chinese mainland.	cn
InstanceId	string	Yes	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	waf_v2_public_cn-uax***b09
Type	string	No	The type of statistics to be detected. Valid values: risk: risk impact statistics event: attack impact statistics	asset_num
ClusterId	string	No	The ID of the hybrid cloud cluster. Note For hybrid cloud scenarios only, you can call the DescribeHybridCloudClusters operation to query the hybrid cloud clusters.	428
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
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-aek2***uwbs5q

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	221F0F14-54C6-59A1-9967-72***81B61A
Data	object	The check results.
High	long	The number of high-risk events.	10
ToBeFixed	long	The number of risks to be fixed.	10
Ignore	long	The number of ignored risks.	0
TodayTotal	string	The total number of new events today.	30
TodayMedium	string	The number of new moderate-risk events today.	10
TodayHigh	string	The number of new high-risk events today.	10
Low	long	The number of low-risk events.	10
Medium	long	The number of moderate-risk events.	10
Total	long	The total number of events.	30
TodayLow	long	The number of new low-risk events today.	10
ToBeConfirmed	long	The number of events to be confirmed.	10
Api	long	The number of APIs.	/api/v1/login
Confirmed	long	The number of confirmed events.	10
Domain	long	The number of domain names.	a.aliyun.com
Fixed	long	The number of fixed risks.	0

Examples

Sample success responses

JSONformat

{
  "RequestId": "221F0F14-54C6-59A1-9967-72***81B61A",
  "Data": {
    "High": 10,
    "ToBeFixed": 10,
    "Ignore": 0,
    "TodayTotal": "30",
    "TodayMedium": "10",
    "TodayHigh": "10",
    "Low": 10,
    "Medium": 10,
    "Total": 30,
    "TodayLow": 10,
    "ToBeConfirmed": 10,
    "Api": 0,
    "Confirmed": 10,
    "Domain": 0,
    "Fixed": 0
  }
}

Error codes

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