DescribeApisecEventDetail API Reference - Web Application Firewall

Retrieves the details of an API security event.

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

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Web Application Firewall (WAF) instance. Note You can call the DescribeInstance operation to query the ID of the WAF instance.	waf_elasticity-cn-0xldbqtm005
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-acfm***q
EventId	string	Yes	The ID of the API security event.	18ba94fea9***e66ba0557b7b91
EventScope	string	No	The dimension of the security event. Valid values: ip (default): IP security event. account: account security event.	ip
DetailType	string	No	The type of the detailed information about the security event. Valid values: event_info (default): attack details. api_info: API information. cnt_info: attack trend. ip_info: attacker IP information. sensitive_info: information about access to sensitive data. request_data: request information. response_data: response information.	event_info
ClusterId	string	No	The ID of the Hybrid Cloud WAF cluster. Note This parameter applies only to hybrid cloud scenarios. You can call the DescribeHybridCloudClusters operation to query information about hybrid cloud WAF clusters.	428

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
EventId	string	The ID of the API security event.	18ba94fea9***e66ba0557b7b91
EventTag	string	The type of the security event. Note You can call the DescribeApisecRules operation to query the supported event types.	ObtainSensitiveUnauthorized
AttackerList	array	The list of attackers associated with the security event.
	string	The attacker identifier. Note If the EventScope parameter is set to ip, this parameter indicates the attacker IP address. If the EventScope parameter is set to account, this parameter indicates the attacker account.	104.234.140.**
AttackCnt	string	The total number of attacks in the security event.	345
StartTs	string	The beginning of the time range during which the security event occurred. This value is a UNIX timestamp. Unit: seconds.	1683648000
EndTs	string	The end of the time range during which the security event occurred. This value is a UNIX timestamp. Unit: seconds.	1683703260
Origin	string	The source of the event type rule. Valid values: custom: a user-defined rule. default: a built-in rule.	custom
EventLevel	string	The severity level of the security event. Valid values: high: high severity. medium: medium severity. low: low severity.	low
UserStatus	string	The event status. Valid values: toBeConfirmed: to be confirmed. confirmed: confirmed. actioned: handled. ignored: ignored.	toBeConfirmed
Note	string	The remarks added to the security event.	already confirmed.
EventScope	string	The dimension of the security event. Valid values: ip (default): IP security event. account: account security event.	ip
DetailValue	string	The details of the security event.	{\"location\":[\"FR\",\"CN\"],\"location_type\":\"country\"}

Examples

Success response

JSON format

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "EventId": "18ba94fea9***e66ba0557b7b91",
  "EventTag": "ObtainSensitiveUnauthorized",
  "AttackerList": [
    "104.234.140.**"
  ],
  "AttackCnt": "345",
  "StartTs": "1683648000",
  "EndTs": "1683703260",
  "Origin": "custom",
  "EventLevel": "low",
  "UserStatus": "toBeConfirmed",
  "Note": "already confirmed.",
  "EventScope": "ip",
  "DetailValue": "{\\\"location\\\":[\\\"FR\\\",\\\"CN\\\"],\\\"location_type\\\":\\\"country\\\"}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.