Querying the QPS_AAD Overview_AAD APIs_API Reference

Function

This API is used to query the QPS.

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/domains/waf-info/flow/qps

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
domains	No	String	If this parameter is not provided, all domain names are queried.
value_type	Yes	String	For QPS and bandwidths, mean for the average value and peak for the peak value. For response status codes, source for the status codes from the origin server and proxy for the status codes from the AAD instance.
start_time	No	String	Start time.
end_time	No	String	End time.
recent	No	String	Enumeration values: yesterday, today, 3 days, 1 week, 1 month You need to configure either this parameter or the timestamp.
overseas_type	No	Integer	Instance type. 0: the Chinese mainland. 1: outside the Chinese mainland.
limit	No	Integer	Maximum records.
offset	No	Integer	Offset.

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
curve	Array of Point objects	curve

**Table 4** Point
Parameter	Type	Description
time	Integer	Timestamp
total	Integer	Total requests
attack	Integer	Total attacks
basic	Integer	Basic web protection.
cc	Integer	Frequency control.
custom_custom	Integer	Precise protection

Example Requests

Query the average request QPS of domains 74af0d26xxxxxxxxx579b0ccd in the last three days from 1736304018728 to 1757333936688.

GET https://{endpoint}/v2/aad/domains/waf-info/flow/qps?domains=74af0d26xxxxxxxxx579b0ccd&value_type=mean&start_time=1736304018728&end_time=1757333936688&recent=3days&overseas_type=0&limit=10&offset=0

Example Responses

Status code: 200

{
  "curve" : [ {
    "time" : 0,
    "total" : 0,
    "attack" : 0,
    "basic" : 0,
    "cc" : 0,
    "custom_custom" : 0
  } ]
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

Querying the QPS