DescribePortAttackMaxFlow - Anti-DDoS - Alibaba Cloud Documentation Center

Operation description

You can call this operation to query the peak bandwidth and peak packet rate of attack traffic on one or more Anti-DDoS Pro or Anti-DDoS Premium instances within a specific period of time.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs in Resource Management. If you do not configure this parameter, the instance belongs to the default resource group.	rg-acfm2pz25js****
EndTime	integer	Yes	The end of the time range to query. This value is a UNIX timestamp. Unit: seconds. Note This UNIX timestamp must indicate a point in time that is accurate to the minute.	1583683200
StartTime	integer	Yes	The beginning of the time range to query. This value is a UNIX timestamp. Unit: seconds. Note This UNIX timestamp must indicate a point in time that is accurate to the minute.	1582992000
InstanceIds	array	Yes	The IDs of the Anti-DDoS Proxy instances to query.	ddoscoo-cn-mp91j1ao****
	string	No	The ID of the Anti-DDoS Proxy instance to query. Note You can call the DescribeInstanceIds operation to query the IDs of all Anti-DDoS Proxy instances.	ddoscoo-cn-zvp2eibz****

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

For more information about sample requests, see the "Examples" section of this topic.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E
Bps	integer	The peak bandwidth of attack traffic. Unit: bit/s.	149559
Pps	integer	The peak packet rate of attack traffic . Unit: packets per second (pps).	23

Examples

Success response

JSON format

{
  "RequestId": "C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E",
  "Bps": 149559,
  "Pps": 23
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.