接口功能介绍
查询告警列表
接口约束
传参规范
URI
GET /vfw/v2_alarm_query
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| firewallId | 是 | String | 防火墙id | c7cfe772fd3f482da630132e6548a19a | |
| startTime | 是 | String | 开始时间不为空 | 2024-10-23T08:31:25Z | |
| finishTime | 是 | String | 结束时间不为空 | 2024-10-23T08:31:25Z | |
| attackApp | 否 | Array of Longs | 攻击应用 | [1] | |
| attackType | 否 | Array of Strings | 攻击类型 | ["Vulnerability-CSRF"] | |
| attackLevel | 否 | Array of Strings | 攻击等级 | ["LOW"] | |
| sourceType | 否 | Array of Strings | 判断来源 | ["BASE"] | |
| attackDirection | 否 | Array of Strings | 方向 | ["1"] | |
| attackIp | 否 | String | 攻击ip | 1.1.1.1 | |
| affectedIp | 否 | String | 受影响ip | 2.2.2.2 | |
| page | 否 | Integer | 页码 | 1 | |
| size | 否 | Integer | 页大小 | 10 |
请求参数
请求头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 | 接口返回结果 | PageInfo |
表 PageInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总记录数 | 1 | |
| list | Array of Objects | 结果集 | AlarmView | |
| pageNum | Integer | 当前页的页码 | 1 | |
| pageSize | Integer | 每页的数量 | 10 | |
| size | Integer | 当前页的数量 | 1 | |
| startRow | Long | 当前页面第一个元素在数据库中的行号 | 1 | |
| endRow | Long | 当前页面最后一个元素在数据库中的行号 | 1 | |
| pages | Integer | 总页数 | 1 | |
| prePage | Integer | 前一页 | 0 | |
| nextPage | Integer | 下一页 | 0 | |
| isFirstPage | Boolean | 是否为首页 | true | |
| isLastPage | Boolean | 是否为末页 | true | |
| hasPreviousPage | Boolean | 是否有前一页 | false | |
| hasNextPage | Boolean | 是否有下一页 | false | |
| navigatePages | Integer | 导航页码数 | 8 | |
| navigatepageNums | Array of Integers | 所有导航页号 | [1] | |
| navigateFirstPage | Integer | 导航条上的第一页 | 1 | |
| navigateLastPage | String | 导航条上的最后一页 | 1 |
表 AlarmView
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| createTime | String | 创建时间 | 2024-10-24T01:44:12Z | |
| updateTime | String | 修改时间 | 2024-10-24T01:44:12Z | |
| alarmName | String | 告警名称 | 100.126.9.172_192.168.10.5_POP3_Weak_Password_Login_Attempt(TCP)告警 | |
| attackType | String | 攻击类型 | InformationDisclosure-WeakPassword | |
| attackIp | String | 攻击ip | 100.126.9.172 | |
| affectedIp | String | 受影响ip | 192.168.10.5 | |
| attackLevel | String | 攻击等级 | "MIDDLE" | |
| triggerCount | Integer | 触发次数 | 1 | |
| ruleId | Long | 命中规则id | 43049 | |
| ruleName | String | 命中规则名称 | POP3_Weak_Password_Login_Attempt(TCP) | |
| sourceType | String | 判断来源 | BASE | |
| attackDirection | String | 方向 | 1 | |
| isHandled | Boolean | 标记处理 | false | |
| alarmId | String | 告警id | 119320 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{}
响应示例
{
"statusCode": "200",
"error": "CFW_0000",
"message": "成功!",
"returnObj": {
"total": 12,
"list": [
{
"createTime": "2024-10-24T01:44:12Z",
"updateTime": "2024-10-24T01:44:12Z",
"alarmName": "100.126.9.172_192.168.10.5_POP3_Weak_Password_Login_Attempt(TCP)告警",
"attackType": "InformationDisclosure-WeakPassword",
"attackIp": "100.126.9.172",
"affectedIp": "192.168.10.5",
"attackLevel": "MIDDLE",
"triggerCount": 1,
"ruleId": 43049,
"ruleName": "POP3_Weak_Password_Login_Attempt(TCP)",
"sourceType": "BASE",
"attackDirection": "1",
"isHandled": false,
"alarmId": "119320"
}
],
"pageNum": 1,
"pageSize": 10,
"size": 10,
"startRow": 1,
"endRow": 10,
"pages": 2,
"prePage": 0,
"nextPage": 2,
"isFirstPage": true,
"isLastPage": false,
"hasPreviousPage": false,
"hasNextPage": true,
"navigatePages": 8,
"navigatepageNums": [
1,
2
],
"navigateFirstPage": 1,
"navigateLastPage": 2
},
"statusCode": "800"
}
状态码
请参考 状态码
错误码
请参考 错误码
