接口功能介绍
安全告警统计
接口约束
传参规范
URI
GET /vfw/v2_alarm_statics
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| firewallId | 是 | String | 防火墙id | c7cfe772fd3f482da630132e6548a19a | |
| startTime | 是 | String | 开始时间不为空 | 2024-10-23T08:31:25Z | |
| finishTime | 是 | String | 结束时间不为空 | 2024-10-23T08:31:25Z |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| urlType | 是 | String | 请求地址类型 | CTAPI | |
| regionId | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 | ||
| message | String | 返回信息 | 成功 | |
| error | String | 错误码：CFW_0000 :成功!;CFW_0001:参数错误！;CFW_0002：业务错误！ | CFW_0000 | |
| returnObj | Object | 接口返回结果 | AlarmStaticsView |
表 AlarmStaticsView
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| runMode | String | 告警模式 | 1 | |
| alarmOverview | Object | 告警统计 | AlarmOverview | |
| attackTypes | Object | 攻击类型统计 | AttackTypes | |
| attackLevel | Object | 攻击等级统计 | AttackLevels |
表 AlarmOverview
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| alarmCount | Integer | 告警次数 | 1 | |
| dropCount | Integer | 已拦截次数 | 1 | |
| alertCount | Integer | 仅告警次数 | 1 | |
| attackIpCount | Integer | 攻击IP数 | 1 | |
| affectedIpCount | Integer | 受影响IP数 | 2 |
表 AttackTypes
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| InformationDisclosure | Integer | 扫描数 | 1 | |
| Malware | Integer | 木马数 | 1 | |
| Malwaretraffic | Integer | 暴力破解数 | 1 | |
| Dos | Integer | ddos数 | 1 | |
| Networkmonitor | Integer | webshell数 | 2 | |
| Protocolexception | Integer | Protocolexception数 | 1 | |
| Vulnerability | Integer | 漏洞数 | 2 | |
| Other | Integer | 其他 | 1 |
表 AttackLevels
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| serious | Integer | 严重数 | 1 | |
| high | Integer | 高危数 | 1 | |
| middle | Integer | 中危数 | 1 | |
| low | Integer | 低危数 | 1 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{}
响应示例
{
"statusCode": "200",
"error": "CFW_0000",
"message": "成功!",
"returnObj": {
"runMode": "BLOCK",
"alarmOverview": {
"alarmCount": 12,
"dropCount": 0,
"alertCount": 12,
"attackIpCount": 8,
"affectedIpCount": 8
},
"attackTypes": {
"InformationDisclosure": 12,
"ProtocolException": 0,
"MalwareTraffic": 0,
"NetworkMonitor": 0,
"DoS": 0,
"Malware": 0,
"Vulnerability": 0,
"Other": 0
},
"attackLevel": {
"high": 0,
"middle": 12,
"low": 0,
"serious": 0
},
"attackLevels": {
"serious": 0,
"high": 0,
"middle": 12,
"low": 0
}
},
"statusCode": "800"
}
状态码
请参考 状态码
错误码
请参考 错误码
