DescribeUserEventType - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the types and statistics of user 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:DescribeUserEventType

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to query the ID of the WAF instance.	waf_v2_public_cn-5y***h0t
ClusterId	string	No	The ID of the hybrid cloud cluster. Note This parameter applies only to hybrid cloud scenarios. Call DescribeHybridCloudClusters to obtain information about hybrid cloud clusters.	976
StartTime	integer	No	The start time of the query. The value is a UNIX timestamp in UTC. Unit: seconds.	1723435200
EndTime	integer	No	The end time of the query. The value is a UNIX timestamp in UTC. Unit: seconds.	1726113600
RegionId	string	No	The region of the WAF instance. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: regions outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-aek***ktt3y
UserStatusList	array	No	A list of security event statuses. Note By default, statistics are collected for security events in the toBeConfirmed, confirmed, and actioned states.
	string	No	The status of the security event. Valid values: toBeConfirmed: to be confirmed. confirmed: confirmed. actioned: handled. ignored: ignored.	toBeConfirmed
EventScope	string	No	The dimension of the security event. Valid values: ip (default): IP security events. account: account security events.	ip

Response elements

Element	Type	Description	Example
	object	The response to the request.
RequestId	string	The ID of the request.	177BA739-6512-5470-98C6-E***0BAA3D
Event	array<object>	A list of security event types and their statistics.
	object	The type and statistics of the event.
EventCount	integer	The number of events.	0
EventType	string	The type of the event. Note Call DescribeApisecRules to obtain the supported event types.	Event_LoginCollision
EventParentType	string	The parent type of the event.	EventType_Account
EventCode	string	The event code.	Event_LoginCollision

Examples

Success response

JSON format

{
  "RequestId": "177BA739-6512-5470-98C6-E***0BAA3D",
  "Event": [
    {
      "EventCount": 0,
      "EventType": "Event_LoginCollision",
      "EventParentType": "EventType_Account",
      "EventCode": "Event_LoginCollision"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.