文档首页/ Web应用防火墙 WAF/ API参考/ API/ 安全总览/ 查询安全统计qps次数
更新时间：2024-12-06 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询安全统计qps次数

功能介绍

查询安全统计qps次数。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

通过企业项目管理服务的查询企业项目列表接口ListEnterpriseProject查询通过企业项目管理服务的查询企业项目列表接口ListEnterpriseProject查询企业项目ID

from

是

Long

起始时间（13位毫秒时间戳），需要和to同时使用

to

是

Long

结束时间（13位毫秒时间戳），需要和from同时使用

hosts

否

String

域名id，通过查询云模式防护域名列表（ListHost）获取域名id或者通过独享模式域名列表（ListPremiumHost）获取域名id

instances

否

String

要查询引擎实例id（仅独享或者ELB实例化模式涉及）

group_by

否

String

展示维度，按天展示时传"DAY"；默认不传，按照分钟展示

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

是

String

内容类型

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of StatisticsTimelineItem objects

安全总览的Qps时间线统计数据
表5 StatisticsTimelineItem

参数

参数类型

描述

key

String

键值，包括请求总量（ACCESS）、Bot攻击防护（CRAWLER）、攻击总量（ATTACK）、Web基础防护（WEB_ATTACK）、精准防护（PRECISE）、CC攻击防护（CC）

timeline

Array of TimeLineItem objects

对应键值的时间线统计数据
表6 TimeLineItem

参数

参数类型

描述

time

Long

时间点

num

Integer

time对应时间点与前一时间点间隔内的统计数值。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表8 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表12 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

查询项目id为project_id，时间从2022-04-21 00:00:00到2022-04-21 14:35:36的安全统计qps次数。

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

响应示例

状态码： 200

ok

[ {
  "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" : "ATTACK",
  "timeline" : [ {
    "time" : 1650470400000,
    "num" : 0
  } ]
}, {
  "key" : "WEB_ATTACK",
  "timeline" : [ {
    "time" : 1650470400000,
    "num" : 0
  } ]
} ]

状态码

状态码

描述

200

ok

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： 安全总览

相关文档