All Products
Search
Document Center

:DescribeFreeUserEvents

Last Updated:Nov 15, 2024

Queries the list of security events on which basic detection is performed in the API security module.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-waf:DescribeFreeUserEventsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

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_v3prepaid_public_cn-27a3****
RegionIdstringNo

The region in which the WAF instance is deployed. Valid values:

  • cn-hangzhou: Chinese mainland
  • ap-southeast-1: outside the Chinese mainland
cn-hangzhou
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfm***q

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

8A2DF88D-90C2-56E9-B8D5-36BB9646791C
Eventarray<object>

The security events on which basic detection is performed.

Eventobject

The security event on which basic detection is performed.

EventTagstring

The type of the security event.

Note You can call the DescribeApisecRules operation to query the supported types of security events.
Event_DataTraverse
ApiFormatstring

The API.

/api/login
Domainstring

The domain name of the API.

www.***.cn
AttackIPstring

The attacker IP address.

104.234.140.**
AttackTimelong

The time at which the attack was launched. The value is a UNIX timestamp displayed in UTC. Unit: seconds.

1683703260
EventLevelstring

The severity level of the security event. Valid values:

  • high
  • medium
  • low
high

Examples

Sample success responses

JSONformat

{
  "RequestId": "8A2DF88D-90C2-56E9-B8D5-36BB9646791C",
  "Event": [
    {
      "EventTag": "Event_DataTraverse",
      "ApiFormat": "/api/login",
      "Domain": "www.***.cn",
      "AttackIP": "104.234.140.**",
      "AttackTime": 1683703260,
      "EventLevel": "high"
    }
  ]
}

Error codes

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