安全事件

POST 查询攻击数据

POST /prod-api/waf/wafv3/statistic/describeAttackData

Body 请求参数

{
  "action": [
    {
      "metricName": "attack_thread",
      "pageNo": 1,
      "pageSize": 5
    },
    {
      "metricName": "block_thread",
      "pageNo": 1,
      "pageSize": 5
    }
  ],
  "otherFilter": [],
  "params": {
    "beginTime": "2024-11-25 14:18:31",
    "endTime": "2024-11-25 15:18:31"
  }
}

请求参数

名称	位置	类型	必选	中文名	说明
Authorization	header	string	否		none
body	body	object	否		none
» action	body	[object]	否		none
»» metricName	body	string	否		metricName: "attack_thread(威胁）"metricName: "block_thread(拦截）
»» pageNo	body	integer(int32)	否	当前页数	none
»» pageSize	body	integer(int32)	否	每页显示条目个数	none
» domains	body	[string]	否		none
» interval	body	string	否		none
» otherFilter	body	[object]	否		none
»» oneVal	body	string	否	搜索名称	oneVal: "oid(套餐）
»» threeVal	body	[string]	否	搜索值	none
»» twoVal	body	string	否	等于或者不等于	eq（等于）ne（不等于）
» pageNum	body	integer(int32)	否	当前页数	none
» pageSize	body	integer(int32)	否	每页显示条目个数	none
» params	body	object	否		none
»» beginTime	body	string	是	开始时间	none
»» endTime	body	string	是	结束时间	none
» searchHeader	body	object	否		none
» terminal	body	string	否		none
» userId	body	integer(int64)	否		none

详细说明

»» oneVal: oneVal: "oid(套餐） "oneVal: "client_ip(来源IP） "oneVal: "oneVal(客户端） "oneVal: "domain(域名） "oneVal: "url(URL） "oneVal: "status(状态码） "oneVal: "request_method(请求方法） "oneVal: "server_port(端口） "oneVal: "ua_os_name(操作系统） "oneVal: "ua_name(浏览器） "oneVal: "rule_tags(规则标签） "oneVal: "client_country_name(国家/地区） "oneVal: "client_city_name(城市）" "oneVal: "waf_acl_id(策略组 ）" "oneVal: "rule_Id(规则ID）"

返回示例

[
  {
    "metricName": "attack_thread",
    "objectArrayList": [
      [
        1732584900000,
        6
      ]
    ],
    "total": 422
  },
  {
    "metricName": "block_thread",
    "objectArrayList": [
      [
        1732586700000,
        2
      ],
      [
        1732586760000,
        0
      ],
      [
        1732586820000,
        0
      ]
    ],
    "total": 4
  }
]

201 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline
201	Created	none	Inline
401	Unauthorized	none	Inline
403	Forbidden	none	Inline
404	Not Found	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» metricName	string	true	none	获取数据名称	none
» objectArrayList	[array]	true	none	统计图	attack_thread：攻击统计图；block_thread：拦截统计图
» total	integer	true	none	总次数	none

POST 查询高级监控数据

POST /prod-api/waf/wafv3/statistic/describeMostData

Body 请求参数

{
  "action": [],
  "otherFilter": [],
  "params": {
    "beginTime": "2024-11-25 14:18:31",
    "endTime": "2024-11-25 15:18:31"
  }
}

请求参数

名称	位置	类型	必选	中文名	说明
Authorization	header	string	否		none
body	body	object	否		none
» action	body	[object]	否		none
»» metricName	body	string	否	名称	metricName: "oid(套餐）"metricName: "client_ip(来源IP）"metricName: "http_user_agent(客户端）"metricName: "domain(域名）"metricName: "url(URL）"metricName: "status(状态码）"metricName: "request_method(请求方法）"metricName: "server_port(端口）"metricName: "ua_os_name(操作系统）"metricName: "ua_name(浏览器）"metricName: "rule_tags(规则标签）"metricName: "client_country_name(国家/地区）"metricName: "client_city_name(城市）"
»» pageNo	body	integer(int32)	否	当前页数	none
»» pageSize	body	integer(int32)	否	每页显示条目个数	none
» domains	body	[string]	否		none
» interval	body	string	否		none
» otherFilter	body	[object]	否		none
»» oneVal	body	string	否	搜索名称	例如:
»» threeVal	body	[string]	否	搜索值	none
»» twoVal	body	string	否	等于或者不等于	eq（等于）ne（不等于）
» pageNum	body	integer(int32)	否	当前页数	none
» pageSize	body	integer(int32)	否	每页显示条目个数	none
» params	body	object	否		none
»» beginTime	body	string	是	开始时间	none
»» endTime	body	string	是	结束时间	none

详细说明

»» oneVal: 例如: oneVal: "oid(套餐） "oneVal: "client_ip(来源IP） "oneVal: "oneVal(客户端） "oneVal: "domain(域名） "oneVal: "url(URL） "oneVal: "status(状态码） "oneVal: "request_method(请求方法） "oneVal: "server_port(端口） "oneVal: "ua_os_name(操作系统） "oneVal: "ua_name(浏览器） "oneVal: "rule_tags(规则标签） "oneVal: "client_country_name(国家/地区） "oneVal: "client_city_name(城市）" "oneVal: "waf_acl_id(策略组 ）" "oneVal: "rule_Id(规则ID）"

返回示例

[
  {
    "metricName": "oid",
    "list": [
      {
        "name": "993128",
        "value": 1082
      }
    ],
    "total": 1082,
    "termsCount": 1
  },
  {
    "metricName": "client_ip",
    "list": [
      {
        "name": "1.1.1.1",
        "value": 1081
      }
    ],
    "total": 1082,
    "termsCount": 2
  },
  {
    "metricName": "http_user_agent",
    "list": [
      {
        "name": "Mozilla/5Firefox/132.0",
        "value": 383
      }
    ],
    "total": 1010,
    "termsCount": 6
  },
  {
    "metricName": "domain",
    "list": [
      {
        "name": "oa.demo.com",
        "value": 1081
      }
    ],
    "total": 1082,
    "termsCount": 2
  }
]

201 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline
201	Created	none	Inline
401	Unauthorized	none	Inline
403	Forbidden	none	Inline
404	Not Found	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» metricName	string	true	none		none
» list	[object]	true	none		none
»» name	string	true	none		none
»» value	integer	true	none		none
» total	integer	true	none		none
» termsCount	integer	true	none		none

POST 查询规则触发规则占比

POST /prod-api/waf/wafv3/statistic/describeRulesProportion

Body 请求参数

{
  "action": [],
  "otherFilter": [],
  "params": {
    "beginTime": "2024-11-25 14:18:31",
    "endTime": "2024-11-25 15:18:31"
  }
}

请求参数

名称	位置	类型	必选	中文名	说明
Authorization	header	string	否		none
body	body	object	否		none
» action	body	[Action]	否		none
»» Action	body	Action	否	Action	none
»»» metricName	body	string	否		none
»»» pageNo	body	integer(int32)	否		none
»»» pageSize	body	integer(int32)	否		none
» domains	body	[string]	否		none
» interval	body	string	否		none
» otherFilter	body	[object]	否	筛选条件	none
»» oneVal	body	string	否	搜索名称	oneVal: "oid(套餐）
»» threeVal	body	[string]	否	搜索值	none
»» twoVal	body	string	否	等于或者不等于	eq（等于）ne（不等于）
» pageNum	body	integer(int32)	否	当前页数	none
» pageSize	body	integer(int32)	否	每页显示条目个数	none
» params	body	object	否		none
»» beginTime	body	string	是	开始时间	none
»» endTime	body	string	是	结束时间	none
» searchHeader	body	object	否		none
» terminal	body	string	否		none
» userId	body	integer(int64)	否		none

详细说明

»» oneVal: oneVal: "oid(套餐） "oneVal: "client_ip(来源IP） "oneVal: "oneVal(客户端） "oneVal: "domain(域名） "oneVal: "url(URL） "oneVal: "status(状态码） "oneVal: "request_method(请求方法） "oneVal: "server_port(端口） "oneVal: "ua_os_name(操作系统） "oneVal: "ua_name(浏览器） "oneVal: "rule_tags(规则标签） "oneVal: "client_country_name(国家/地区） "oneVal: "client_city_name(城市）" "oneVal: "waf_acl_id(策略组 ）" "oneVal: "rule_Id(规则ID）"

返回示例

{
  "msg": "成功",
  "code": 200,
  "data": {
    "customRule": 0,
    "customLimitRule": 0,
    "custodyRule": 0
  }
}

201 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline
201	Created	none	Inline
401	Unauthorized	none	Inline
403	Forbidden	none	Inline
404	Not Found	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» msg	string	true	none		none
» code	integer	true	none		none
» data	object	true	none		none
»» customRule	integer	true	none	自定义规则	none
»» customLimitRule	integer	true	none	限速规则	none
»» custodyRule	integer	true	none	基础防护规则	none

POST 查询触发的规则

POST /prod-api/waf/wafv3/statistic/describeTriggeredRules

Body 请求参数

{
  "action": [
    {
      "metricName": "rule_Id",
      "pageNo": 1,
      "pageSize": 5
    },
    {
      "metricName": "waf_acl_id",
      "pageNo": 1,
      "pageSize": 5
    }
  ],
  "otherFilter": [],
  "params": {
    "beginTime": "2024-11-25 14:18:31",
    "endTime": "2024-11-25 15:18:31"
  }
}

请求参数

名称	位置	类型	必选	中文名	说明
Authorization	header	string	否		none
body	body	object	否		none
» action	body	[object]	否		none
»» metricName	body	string	否	获取数据名称	waf_acl_id：策略组；rule_Id:规则列表
»» pageNo	body	integer(int32)	否	当前页数	none
»» pageSize	body	integer(int32)	否	每页显示条目个数	none
» domains	body	[string]	否		none
» interval	body	string	否		none
» otherFilter	body	[object]	否	筛选条件	none
»» oneVal	body	string	否	搜索名称	oneVal: "oid(套餐）
»» threeVal	body	[string]	否	搜索值	none
»» twoVal	body	string	否	等于或者不等于	eq（等于）ne（不等于）
» pageNum	body	integer(int32)	否	当前页数	none
» pageSize	body	integer(int32)	否	每页显示条目个数	none
» params	body	object	否		none
»» beginTime	body	string	是	开始时间	none
»» endTime	body	string	是	结束时间	none
» searchHeader	body	object	否		none
» terminal	body	string	否		none
» userId	body	integer(int64)	否		none

详细说明

»» oneVal: oneVal: "oid(套餐） "oneVal: "client_ip(来源IP） "oneVal: "oneVal(客户端） "oneVal: "domain(域名） "oneVal: "url(URL） "oneVal: "status(状态码） "oneVal: "request_method(请求方法） "oneVal: "server_port(端口） "oneVal: "ua_os_name(操作系统） "oneVal: "ua_name(浏览器） "oneVal: "rule_tags(规则标签） "oneVal: "client_country_name(国家/地区） "oneVal: "client_city_name(城市）" "oneVal: "waf_acl_id(策略组 ）" "oneVal: "rule_Id(规则ID）"

返回示例

{
  "msg": "成功",
  "code": 200,
  "data": [
    {
      "metricName": "rule_Id",
      "list": [],
      "total": 0,
      "termsCount": 0
    },
    {
      "metricName": "waf_acl_id",
      "list": [],
      "total": 0,
      "termsCount": 0
    }
  ]
}

201 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline
201	Created	none	Inline
401	Unauthorized	none	Inline
403	Forbidden	none	Inline
404	Not Found	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» msg	string	true	none		none
» code	integer	true	none		none
» data	[object]	true	none		none
»» metricName	string	true	none		none
»» list	[string]	true	none		none
»» total	integer	true	none		none
»» termsCount	integer	true	none		none

数据模型

Action

{
  "metricName": "string",
  "pageNo": 0,
  "pageSize": 0
}

Action

属性

名称	类型	必选	约束	中文名	说明
metricName	string	false	none		none
pageNo	integer(int32)	false	none		none
pageSize	integer(int32)	false	none		none

DescribeWafV3StatisticVO

{
  "action": [
    {
      "metricName": "string",
      "pageNo": 0,
      "pageSize": 0
    }
  ],
  "domains": [
    "string"
  ],
  "interval": "string",
  "otherFilter": [
    {
      "oneVal": "string",
      "threeVal": [
        "string"
      ],
      "threeVals": [
        "string"
      ],
      "twoVal": "string"
    }
  ],
  "pageNum": 0,
  "pageSize": 0,
  "params": {
    "beginTime": "string",
    "endTime": "string"
  },
  "searchHeader": {},
  "terminal": "string",
  "userId": 0
}

DescribeWafV3StatisticVO

属性

名称	类型	必选	约束	中文名	说明
action	[Action]	false	none		none
domains	[string]	false	none		none
interval	string	false	none		none
otherFilter	[StatisticOtherFilterVO]	false	none		none
pageNum	integer(int32)	false	none	当前页数	none
pageSize	integer(int32)	false	none	每页显示条目个数	none
params	object	false	none		none
» beginTime	string	true	none	开始时间	none
» endTime	string	true	none	结束时间	none
searchHeader	object	false	none		none
terminal	string	false	none		none
userId	integer(int64)	false	none		none

StatisticOtherFilterVO

{
  "oneVal": "string",
  "threeVal": [
    "string"
  ],
  "threeVals": [
    "string"
  ],
  "twoVal": "string"
}

StatisticOtherFilterVO

属性

名称	类型	必选	约束	中文名	说明
oneVal	string	false	none		none
threeVal	[string]	false	none		none
threeVals	[string]	false	none		none
twoVal	string	false	none		none