Querying DDoS Attack Protection BPS/PPS Traffic_AAD Overview_AAD APIs_API Reference

Function

This API is used to query DDoS attack protection BPS/PPS traffic.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/aad/instances/{instance_id}/ddos-info/flow

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
instance_id	Yes	String	Instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
ip	Yes	String	Advanced Anti-DDoS IP address
type	Yes	String	Request type: pps or bps.
start_time	Yes	String	Start time.
end_time	Yes	String	End time.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	token
Content-Type	Yes	String	Content-Type

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
flow_bps	Array of FlowBps objects	This parameter is mandatory if type is set to bps.
flow_pps	Array of FlowPps objects	This parameter is mandatory if type is set to pps.

**Table 5** FlowBps
Parameter	Type	Description
utime	Integer	Data time
attack_bps	Integer	Attack traffic
normal_bps	Integer	Normal traffic

**Table 6** FlowPps
Parameter	Type	Description
utime	Integer	Data time
attack_pps	Integer	Attack packet rate.
normal_pps	Integer	Normal packet rate.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Error description.

Example Requests

https://{endpoint}/v2/aad/instances/eac890d4-xxxx-xxxx-xxxx-94dd857e143a/ddos-info/flow?ip=10.xx.xx.10&type=pps&start_time=1727271941686&end_time=1727358311686

Example Responses

Status code: 200

{
  "flow_pps" : [ {
    "utime" : 11,
    "attack_pps" : 47,
    "normal_pps" : 51
  } ]
}

Status Codes

Status Code	Description
200	OK
400	Error response

Error Codes

See Error Codes.

Querying DDoS Attack Protection BPS/PPS Traffic