All Products
Search
Document Center

Anti-DDoS:DescribePortAttackMaxFlow

Last Updated:Apr 16, 2024

Queries the peak attack traffic bandwidth and peak attack traffic packet rates of one or more Anti-DDoS Pro or Anti-DDoS Premium instances within a specified period of time.

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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-ddoscoo:DescribePortAttackMaxFlowRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

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****
EndTimelongYes

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
StartTimelongYes

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
InstanceIdsarrayYes

An array that consists of the IDs of instances to query.

stringYes

The ID of the instance to query.

Note You can call the DescribeInstanceIds operation to query the IDs of all 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 parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

C33EB3D5-AF96-43CA-9C7E-37A81BC06A1E
Bpslong

The peak bandwidth of attack traffic. Unit: bit/s.

149559
Ppslong

The peak packet rate of attack traffic . Unit: packets per second (pps).

23

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history