web-application-firewall-dedicated/api-ref/source/apis/dashboard/querying_the_qps_statistics.rst

original_name

ListQpsTimeline.html

Querying the QPS Statistics

Function

This API is used to query the website QPS statistics.

URI

GET /v1/{project_id}/waf/overviews/qps/timeline

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Table 2 Query Parameters

Parameter	Mandatory	Type	Description
from	Yes	Long	Start time (13-digit timestamp in millisecond). This parameter must be used together with to.
to	Yes	Long	End time (13-digit timestamp in millisecond). This parameter must be used together with from.
hosts	No	String	IDs of the domain names you want to query. If this parameter is not specified, all protected domain names are queried by default.
instances	No	String	IDs of the dedicated WAF engine instances you want to query. If this parameter is not specified, all dedicated WAF engine instances are queried by default.
group_by	No	String	How the queried data is displayed. The data can be displayed by the day or by the minute. For example, if the value is set to DAY, data is displayed by the day. By default, this parameter is not included, and data is displayed by the minute.

Request Parameters

Table 3 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Content-Type	Yes	String	Content type. Default value: application/json;charset=utf8 Default: application/json;charset=utf8

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter	Type	Description
[items]	Array of ListQpsTimelineItem <listqpstimeline__response_listqpstimelineitem> objects	ListQpsTimelineResponseBody

Table 5 ListQpsTimelineItem

Parameter	Type	Description
key	String	The following statistics can be included: ACCESS: The number of requests CRAWLER: Crawler attacks identified CC: CC attacks identified WEB_ATTACK: Attacks blocked against basic web protection PRECISE: Attacks blocked against precise protection rules TOTAL_ATTACK: Total number of attacks
timeline	Array of TimeLineItem <listqpstimeline__response_timelineitem> objects	TimeLineItem

Table 6 TimeLineItem

Parameter	Type	Description
time	Long	Time-point
num	Integer	Quantity. Aggregated data is returned.

Status code: 400

Table 7 Response body parameters

Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

Table 8 Response body parameters

Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

Table 9 Response body parameters

Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

GET https://{Endpoint}/v1/{project_id}/waf/overviews/qps/timeline?from=1650470400196&to=1650522936196

Example Responses

Status code: 200

Request succeeded.

[ {
  "key" : "ACCESS",
  "timeline" : [ {
    "time" : 1650470400000,
    "num" : 0
  } ]
}, {
  "key" : "PRECISE",
  "timeline" : [ {
    "time" : 1650470400000,
    "num" : 0
  } ]
}, {
  "key" : "CRAWLER",
  "timeline" : [ {
    "time" : 1650470400000,
    "num" : 0
  } ]
}, {
  "key" : "CC",
  "timeline" : [ {
    "time" : 1650470400000,
    "num" : 0
  } ]
}, {
  "key" : "TOTAL_ATTACK",
  "timeline" : [ {
    "time" : 1650470400000,
    "num" : 0
  } ]
}, {
  "key" : "WEB_ATTACK",
  "timeline" : [ {
    "time" : 1650470400000,
    "num" : 0
  } ]
} ]

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request
401	The token does not have the required permission.
500	Internal server error.

Error Codes

See Error Codes <errorcode>.