DescribeApisecStatistics - Web Application Firewall - Alibaba Cloud Documentation Center

Queries statistics for API security risks or security events.

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

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call the DescribeInstance operation to query the ID of the current WAF instance.	waf_v2_public_cn-uax***b09
Type	string	No	The type of detection statistics. Valid values: risk: statistics on security risks. event: statistics on attacks.	risk
ClusterId	string	No	The ID of the hybrid cloud cluster. Note This parameter is available only in hybrid cloud scenarios. Call the DescribeHybridCloudClusters operation to query information about hybrid cloud clusters.	428
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
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-aek2***uwbs5q
StartTime	integer	No	The start of the time range to query. This value is a UNIX timestamp in seconds. The time is in UTC.	1668496310
EndTime	integer	No	The end of the time range to query. This value is a UNIX timestamp in seconds. The time is in UTC.	1726113600
UserStatusList	array	No	A list of statuses for the detection statistics.
	string	No	The status of the security risk or security event. Note For the supported status values of risks and security events, see the UserStatus request parameter of DescribeApisecAbnormals and DescribeApisecEvents.	toBeConfirmed

Response elements

Element	Type	Description	Example
	object	The request result.
RequestId	string	The request ID.	221F0F14-54C6-59A1-9967-72***81B61A
Data	object	The statistical results.
High	integer	The number of high-risk items.	135
ToBeFixed	integer	The number of items to be fixed.	3
Ignore	integer	The number of ignored items.	3
TodayTotal	string	The total number of new items today.	3
TodayMedium	string	The number of new medium-risk items today.	0
TodayHigh	string	The number of new high-risk items today.	3
Low	integer	The number of low-risk items.	160
Medium	integer	The number of medium-risk items.	27
Total	integer	The total number. Note This is the sum of the values of the High, Medium, and Low response parameters.	322
TodayLow	integer	The number of new low-risk items today.	0
ToBeConfirmed	integer	The number of items to be confirmed.	295
Api	integer	The number of APIs.	202
Confirmed	integer	The number of confirmed items.	11
Domain	integer	The number of domain names.	22
Fixed	integer	The number of items that are manually verified as fixed.	13
Actioned	integer	The number of handled items.	1
ToBeVerified	integer	The number of items to be verified by the system.	2
NotFixed	integer	The number of items that are verified as not fixed.	0
SystemFixed	integer	The number of items that are verified as fixed by the system.	1
Account	integer	The number of accounts.	1

Examples

Success response

JSON format

{
  "RequestId": "221F0F14-54C6-59A1-9967-72***81B61A",
  "Data": {
    "High": 135,
    "ToBeFixed": 3,
    "Ignore": 3,
    "TodayTotal": "3",
    "TodayMedium": "0",
    "TodayHigh": "3",
    "Low": 160,
    "Medium": 27,
    "Total": 322,
    "TodayLow": 0,
    "ToBeConfirmed": 295,
    "Api": 202,
    "Confirmed": 11,
    "Domain": 22,
    "Fixed": 13,
    "Actioned": 1,
    "ToBeVerified": 2,
    "NotFixed": 0,
    "SystemFixed": 1,
    "Account": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.