白名单列表
更新时间 2025-12-24 16:56:08
最近更新时间: 2025-12-24 16:56:08
接口功能介绍
告警中心-白名单列表
接口约束
此功能为收费功能。确认已经购买服务器配额,并且开启服务器防护。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启机器防护。
URI
POST /v1/instrusion/whitelist/allList
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| likeQueryType | 否 | Integer | 模糊查询参数类型 1-服务器ip 2-服务器名称 9-告警名称 | 1 | |
| likeQueryParam | 否 | String | 模糊查询参数 | 1 | |
| currentPage | 是 | Integer | 分页当前页码 | 1 | |
| pageSize | 是 | Integer | 每页大小 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 返回码 | ||
| CTCSSCN_000000:成功 | ||||
| CTCSSCN_000001:失败 | ||||
| CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用 | ||||
| CTCSSCN_000004:鉴权错误 | ||||
| CTCSSCN_000005:用户没有付费版配额,功能不可用 | 0 | |||
| message | String | 返回信息 | success | |
| returnObj | Object | 返回对象 | returnObj | |
| traceId | String | traceId | asaadasd11111 | |
| statusCode | String | 状态码 200-成功 | 200 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总数 | 100 | |
| list | Array of Objects | 结果集 | list | |
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页的数量 | 10 | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | String | 主键 | IW121211 | |
| createTime | String | 创建时间 | 2024-10-22 10:27:00 | |
| updateTime | String | 更新时间 | 2024-10-22 10:27:00 | |
| data | Object | 白名单数据 | data | |
| applyToOther | Boolean | 是否适用于其他主机 | false | |
| effectScope | String | 适用于其他主机的作用范围 OPTIONAL-自选机器 ALL-所有机器 | OPTIONAL | |
| agentGuids | Array of Strings | 适用于其他主机的gui列表 | [] | |
| currentAgentGuids | Array of Strings | 当前guid列表 | [] | |
| remark | String | remark | remark | |
| alarmType | String | 告警类型 1-进程异常行为 2-恶意软件 3-用户异常行为 4-恶意网络连接 5-其他 | 1 | |
| alarmTypeName | String | 告警类型中文名 | 进程异常行为 | |
| alarmName | String | 告警名称 | 篡改系统文件 | |
| alarmNameCode | String | 告警名称-编码 | 3500 | |
| ruleConditionDesc | String | 白名单配置规则描述 | 告警名称 等于 篡改系统文件 且 命令行 等于 sed -i /dbAgentHookOracle.so/d /etc/profile | |
| eventTypeId | String | 告警名称-编码 | 3500 | |
| eventCategoryId | String | 告警类型 1-进程异常行为 2-恶意软件 3-用户异常行为 4-恶意网络连接 5-其他 | 1 | |
| privateIp | String | 私有ip | 192.168.1.1 | |
| publicIp | String | 公有ip | 192.168.1.1 | |
| custName | String | 主机名称 | test | |
| hostName | String | 主机名称 | test | |
| displayName | String | 实例名称 | test | |
| osType | String | 操作系统 Linux/Windows | Linux | |
| count | Integer | 作用服务器数量 | 1 | |
| 表 data |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ruleConditionDesc | String | 规则条件描述 | 告警名称 等于 异常的注册表操作 且 注册表名称 等于 Start 且 注册表路径 等于 \REGISTRY\MACHINE\SYSTEM\ControlSet001\Services\edr_monitor | |
| rules | Array of Objects | 白名单规则数据列表 | rules | |
| 表 rules |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| fieldValue | String | 字段值,字符串反转后进行base64编码,如abc,变成 cba后,用base64编码 | Start | |
| condition | String | 字段条件 =: 等于; !=: 不等于; contain: 包含; not_contain: 不包含; | = | |
| fieldEnName | String | 字段名 | reg_key | |
| fieldZnName | String | 字段中文名 | 注册表名称 | |
| canEdit | Boolean | 是否可编辑 | true |
枚举参数
无
请求示例
请求url
无
请求头header
{"Content-Type": "application/json"}
请求体body
{"likeQueryType": 1, "likeQueryParam": "1", "currentPage": 1, "pageSize": 10}
响应示例
{"message": "success", "traceId": "asaadasd11111", "statusCode": "200", "error": "0", "returnObj": {"total": 100, "list": [{"id": "IW121211", "createTime": "2024-10-22 10:27:00", "updateTime": "2024-10-22 10:27:00", "data": {"ruleConditionDesc": "告警名称 等于 异常的注册表操作 且 注册表名称 等于 Start 且 注册表路径 等于 \\REGISTRY\\MACHINE\\SYSTEM\\ControlSet001\\Services\\edr_monitor", "rules": [{"fieldValue": "Start", "condition": "=", "fieldEnName": "reg_key", "fieldZnName": "注册表名称", "canEdit": "true"}]}, "applyToOther": "false", "effectScope": "OPTIONAL", "agentGuids": [], "currentAgentGuids": [], "remark": "remark", "alarmType": "1", "alarmTypeName": "进程异常行为", "alarmName": "篡改系统文件", "alarmNameCode": "3500", "ruleConditionDesc": "告警名称 等于 篡改系统文件 且 命令行 等于 sed -i /dbAgentHookOracle.so/d /etc/profile", "eventTypeId": "3500", "eventCategoryId": "1", "privateIp": "192.168.1.1", "publicIp": "192.168.1.1", "custName": "test", "hostName": "test", "displayName": "test", "osType": "Linux", "count": 1}], "pageNum": 1, "pageSize": 10}}
状态码
请参考 状态码
错误码
请参考 错误码