Use DescribeApisecEventDomainStatistic to query API security event statistics by domain name - Web Application Firewall

Queries API security event statistics grouped by domain name for a Web Application Firewall (WAF) instance.

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

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 obtain the ID of the WAF instance.	waf_elasticity-cn-0xldbqt****
ClusterId	string	No	The ID of the Hybrid Cloud WAF cluster. Note This parameter is available only for hybrid cloud scenarios. Call the DescribeHybridCloudClusters operation to query Hybrid Cloud WAF clusters.	428
StartTime	integer	No	The beginning of the time range to query. Specify a UNIX timestamp in UTC. Unit: seconds.	1668496310
EndTime	integer	No	The end of the time range to query. Specify a UNIX timestamp in UTC. Unit: seconds.	1686895256
PageNumber	integer	No	The page number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 5. Maximum value: 100.	10
OrderWay	string	No	The sort order of the results. Valid values: asc: sorts the results in ascending order. desc: sorts the results in descending order.	desc
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-acfmvyknl****fa

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of domain names that have API security events.	10
RequestId	string	The ID of the request.	66A98669-*******-80A6-3014697B11AE
Data	array<object>	The API security event statistics grouped by domain name.
	object	The API security event statistics for a specific domain name.
High	integer	The number of high-risk security events for the domain name.	10
ApiCount	integer	The total number of APIs that have security events for the domain name.	10
Low	integer	The number of low-risk security events for the domain name.	2
Medium	integer	The number of medium-risk security events for the domain name.	6
Domain	string	The domain name that is protected by WAF.	a.aliyun.com

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "66A98669-*******-80A6-3014697B11AE",
  "Data": [
    {
      "High": 10,
      "ApiCount": 10,
      "Low": 2,
      "Medium": 6,
      "Domain": "a.aliyun.com"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.