WAF数据报表相关接口

WAF查询实例详情

接口描述

查询waf的实例详情,包括waf实例的状态,waf到期时间,以及配置的规则数量,近日web防护和自定义规则拦截的攻击事件的统计。

  • 注意需要指定waf标志符才能正常调用。

请求结构

GET /v{version}/wafStatistics/{waf_id}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其他特殊头域

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值2
waf_id String URL参数 waf标志符
clientToken String Query参数 幂等性Token,详见幂等性

返回状态码

成功返回200,失败返回见错误码

返回头域

除公共头域外,无其他特殊头域

返回参数

参数名称 类型 描述
payType String 支付方式
wafName String waf名称
status String waf实例状态:可以是available/paused/pausing/updating/deleting/deleted
endTime String 到期时间
rule Object 已经配置的访问规则和剩余可配置的规则
webAttack Object web攻击事件近日统计
customAttack Object 自定义规则攻击事件近日统计

请求示例

GET /v2/wafStatistics/waf-3a4b5c?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2018 08:26:52 GMT
Content-Length: 
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Server: nginx
{
    "payType": "prepay|postpay",          //支付方式
    "wafName": "WAFNAME",                 //WAF NAME
    "status": "STATUS",                         //WAF实例状态:available/paused/pausing/updating/deleting/deleted
    "endTime": "2017-03-14 16:40:43",     //到期时间:本地时间
    "rule": {
        "used": COUNT,                    //已配置的访问规则,INT型      
        "use": INIT,                      //剩余可配置的访问规则,INT型
    },
    "webAttack": {
        "today": COUNT,                   //今天受web攻击次数,INT型      
        "lastWeek": INIT,                 //最近七天受web攻击次数,INT型
    },
    "customAttack":  {
        "today": COUNT,                   //已今天受到自定义规则次数,INT型      
        "lastWeek": INIT,                 //最近其他受到自定义攻击次数,INT型
    },
}

WAF查询攻击事件详情

接口描述

查询一段时间内攻击事件的详情列表。需要指定攻击事件的类型,必须是全部事件、web攻击事件、自定义规则阻拦事件的一种。需要指定开始时间和结束时间,用时间戳表示。

请求结构

GET /v{version}/wafEvent/{waf_id}?type={type}&beginTime={time}&endTime={time}&pageNo={pageno}&pageSize={pagesize}&clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其他特殊头域

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值2
waf_id String URL参数 waf标志符
type String QUERY 参数 取值 all、webAttack、customAttack 分别表示全部事件、web攻击事件、自定义规则阻拦事件
beginTime TIMESTAMP QUERY 参数 时间戳:选择事件开始时间段
endTime TIMESTAMP QUERY 参数 时间戳:选择事件结束时间段
pageNo Int QUERY 参数 显示攻击事件列表页号
pageSize Int QUERY 参数 每页条数
clientToken String Query参数 幂等性Token,详见幂等性

返回状态码

成功返回200,失败返回见错误码

返回头域

除公共头域外,无其他特殊头域

返回参数

参数名称 类型 描述
data List<AttackEvent> waf拦截的攻击事件的列表
total Int 攻击事件的数量

请求示例

GET /v2/wafEvent/waf-3a4b5c?type=webAttack&beginTime=1546963200&endTime=1547625600&pageSize=10&pageNo=1&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

返回示例

HTTP/1.1 200 OK  
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09  
Date: Wed, 10 Apr 2018 08:26:52 GMT  
Content-Length:   
Connection: keep-alive  
Content-Type: application/json;charset=UTF-8  
Server: nginx  
{   
    "data": [  
        {  
            "time": "2017-03-14 19:49:53",            //发生事件,本地时间  
            "bcc": ["instance_id1", "instance_id2"],  //受影响资产  
            "ip": "ip",                               //攻击者IP       
            "addr": "美国",                            //攻击值地址  
            "userAgent": "baidu spider",              //攻击者伪装  
            "url": "URL",                             //攻击者URL        
            "ruleId": "zdy_id",                       //当用户设置自定义后这里为用户自定义规则名字  
            "ruleName": "sql-0001",                   //防御模式  
            "ruleInfo": "SQL注入",                     //安全事件  
            "type": "deny|log",                       //匹配模式  
            "body": "body",                           //匹配内容  
        },  
        {...},  
    ]  
   "total": 1000,                                         //总数  
}

WAF查询一段时间攻击事件的趋势

接口描述

查询24小时内攻击事件发生次数的趋势图,需要指定攻击事件类型,必须是全部事件、web攻击事件、自定义规则阻拦事件的一种。需要指定时间段的结束时刻,用时间戳表示。

请求结构

GET /v{version}/wafCount/{waf_id}?time={time}&type={type}&clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

请求头域

除公共头域外,无其他特殊头域

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值2
time TIMESTMAP QUERY参数 时间戳:选择事件结束时间段
type String QUERY 参数 取值 all、webAttack、customAttack 分别表示全部事件、web攻击事件、自定义规则阻拦事件
clientToken String Query参数 幂等性Token,详见幂等性

返回状态码

成功返回200,失败返回见错误码

返回头域

除公共头域外,无其他特殊头域

返回参数

参数名称 类型 描述
total List<PeriodAttackCount> 一段时间内的每小时的攻击次数的数组

请求示例

GET /v2/wafCount/waf-3a4b5c?time=1546963200&type=webAttack&pageSize=10&pageNo=1&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2018 08:26:52 GMT
Content-Length: 
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Server: nginx
{
   "total":[
       {
           "time":00,
           "total":10
       },
       {
           "time":"12",
           "total":"20"
       },
   ]
}