查询安全总览请求与攻击数量
功能介绍
查询安全总览请求与攻击数量。需要注意的是,安全总览相关的接口,暂时不能支持任意时间的查询。只能支持 console上显示的 昨天,今天,3天,7天和30天 数据查询。
URI
GET /v1/{project_id}/waf/overviews/statistics
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
from |
是 |
Long |
起始时间(13位时间戳),需要和to同时使用 |
to |
是 |
Long |
结束时间(13位时间戳),需要和from同时使用 |
hosts |
否 |
String |
域名id,通过查询云模式防护域名列表(ListHost)获取域名id或者通过独享模式域名列表(ListPremiumHost)获取域名id |
instances |
否 |
String |
要查询引擎实例id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 缺省值:application/json;charset=utf8 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of CountItem objects |
安全总览请求与攻击数据 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
类型,包括请求总量(ACCESS)、Bot攻击防护(CRAWLER)、攻击总量(ATTACK)、Web基础防护(WEB_ATTACK)、精准防护(PRECISE)以及CC攻击防护(CC) |
num |
Integer |
数量 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
GET https://{Endpoint}/v1/{project_id}/waf/overviews/statistics?enterprise_project_id=0&from=1650470400196&to=1650522936196
响应示例
状态码: 200
成功
[ { "key" : "ACCESS", "num" : 1190 }, { "key" : "PRECISE", "num" : 0 }, { "key" : "CRAWLER", "num" : 10 }, { "key" : "WEB_ATTACK", "num" : 22 }, { "key" : "CC", "num" : 0 }, { "key" : "ATTACK", "num" : 32 } ]
状态码
状态码 |
描述 |
---|---|
200 |
成功 |
400 |
请求失败 |
401 |
token权限不足 |
403 |
资源配额不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。