DescribeDDosEventArea - Anti-DDoS - Alibaba Cloud Documentation Center

Operation description

Note

Currently, this operation can be used only to query data about volumetric attacks. It cannot be used to query data about web resource consumption attacks or connection flood attacks.

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-ddoscoo:DescribeDDosEventArea

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EventType	string	Yes	The type of the attack event that you want to query. Valid values: defense: volumetric attack scrubbing events. blackhole: volumetric attack blackhole filtering events.	defense
StartTime	integer	Yes	The UNIX timestamp when the query starts. Unit: seconds. Note You can call DescribeDDosAllEventList to query the start time of all events.	1598948471
Ip	string	Yes	The DDoS protection IP address that is under attack.	203.*.*.199
Range	integer	No	The number of entries to return. Unit: entries.	100

All Alibaba Cloud API operations must include common request parameters. For more information, see Common parameters.

For the request syntax, see the Examples section of this topic.

Response elements

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	11710C9F-BC5E-481A-BEC5-C6D8FBFCA827
Areas	array	The information about the source region from which the volumetric attack was initiated.
	object
InPkts	integer	The number of request packets that were sent from the source region.	228
Area	string	The code of the source region from which the attack was initiated. The code includes Chinese regions (at the province, city, and district levels) and international regions (at the country level). For example, 110000 indicates Beijing, China, and us indicates the United States. Note For more information about the values of this parameter, see Region type parameter values.	110000

Examples

Success response

JSON format

{
  "RequestId": "11710C9F-BC5E-481A-BEC5-C6D8FBFCA827",
  "Areas": [
    {
      "InPkts": 228,
      "Area": "110000"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.