病毒查杀列表接口
更新时间 2025-12-24 17:18:09
最近更新时间: 2025-12-24 17:18:09
接口功能介绍
病毒查杀-病毒查杀列表接口。
接口约束
此功能为收费功能。确认已经购买服务器配额,并且开启服务器防护。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启机器防护。
URI
POST /v1/virus/list
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentPage | 是 | Integer | 当前页 | 1 | |
| pageSize | 是 | Integer | 每页数量 | 10 | |
| paramType | 否 | Integer | 查询参数类型 1-服务器名称 2-服务器ip 5-agentGuid 13-文件md5 | 1 | |
| param | 否 | String | 查询参数 | test | |
| status | 否 | Integer | 状态 0-未处理 1-已隔离 2-已加白 3-已删除 7-已忽略 99-处理中 | 0 | |
| osType | 是 | Integer | 操作系统类型 1-linux 2-windows 3-全部 | 1 | |
| timeType | 是 | String | 时间类型 LAST_ONE_DAY-最近一天 LAST_THREE_DAY-最近三天 LAST_ONE_WEEK-最近一周 LAST_ONE_MONTH-最近一月 LAST_THREE_MONTH-最近三月 SELF_TIME-自定义时间 | LAST_ONE_DAY | |
| startTime | 否 | String | 开始时间 timeType为SELF_TIME时必填 | 2020-01-01 00:00:00 | |
| endTime | 否 | String | 结束时间 timeType为SELF_TIME时必填 | 2020-01-01 00:00:00 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 返回码 | ||
| CTCSSCN_000000:成功 | ||||
| CTCSSCN_000001:失败 | ||||
| CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用 | ||||
| CTCSSCN_000004:鉴权错误 | ||||
| CTCSSCN_000005:用户没有付费版配额,功能不可用 | CTCSSCN_000000 | |||
| message | String | 返回信息 | success | |
| returnObj | Object | 返回对象 | returnObj | |
| traceId | String | traceId | 211111111111111111111 | |
| statusCode | String | 状态码 200-成功 | 200 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总数 | 100 | |
| list | Array of Objects | 结果集 | list | |
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页的数量 | 10 | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| custName | String | 主机名称 | test-host-name | |
| displayName | String | 实例名称 | test-instance-name | |
| publicIp | String | 公网ip | 192.168.1.1 | |
| agentIp | String | agent ip | 192.168.1.1 | |
| agentGuid | String | agentguid | 1234567890 | |
| userName | String | 用户名 | test-user-name | |
| findTime | String | 首次发现时间 | 2022-06-14 10:00:00 | |
| timestamp | String | 最后发现时间 | 2022-06-14 10:00:00 | |
| docId | String | 事件id | test-id | |
| path | String | 文件路径 | /bin/test.sh | |
| virusName | String | 病毒名称 | test-virus-name | |
| severity | String | 威胁等级 1-低危 2-中危 3-高危 | 1 | |
| status | Integer | 状态 0-未处理 1-已隔离 2-已加白 3-已删除 7-已忽略 99-处理中 | 1 | |
| osType | String | 操作系统类型 Linux/Windows | Linux | |
| md5 | String | 文件md5 | 1234567890 | |
| virusHandleType | String | 病毒处理方式 HANDLE-收手动处理 AUTO-自动处理 | HANDLE | |
| quotaVersion | Integer | 配额版本 1-基础版 2-企业版 3-旗舰版 | 1 | |
| virusType | String | 病毒类型 | 普通木马 | |
| pivotalDoc | Integer | 是否关键文件 1-关键文件 0-非关键文件 | 0 | |
| sha256 | String | sha256 | 1234567890 | |
| pid | Integer | 进程id | 1212 | |
| cmd | String | 进程命令行 | /bin/test.sh | |
| checkModel | Integer | 检测模式 1-快速检测 2-全盘检测 3-自定义检测 8-实时监测 9-文件落盘检测 10-进程启动检测 | 1 | |
| taskId | Integer | 任务id | 1 | |
| checkWay | Integer | 检测模式 1-快速检测 2-全盘检测 3-自定义检测 8-实时监测 9-文件落盘检测 10-进程启动检测 | 1 | |
| handleRules | Array of Objects | handleList | ||
| 操作列表 | handleRules | |||
| whiteData | Object | 白名单数据 | whiteData | |
| eventCategoryId | String | 告警类型 | 2 | |
| eventTypeId | String | 告警名称id | 4400 | |
| virusEngine | String | 病毒查杀引擎 | ||
| 1:"云查引擎" | ||||
| 2:"本地查杀引擎" | ||||
| 3:"本地查杀引擎" | 1 | |||
| isAutoIsolate | String | 处理类型 | ||
| 0-手动 1自动 为空展示-- | 0 | |||
| 表 whiteData |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 | |
| 表 handleRules |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 操作名称 | 添加白名单 | |
| label | String | 操作标签 ADD_WHITE-添加白名单 ISOLATE-隔离 DELETE-删除 IGNORE-忽略 | ADD_WHITE |
枚举参数
无
请求示例
请求url
无
请求头header
{"Content-Type": "application/json"}
请求体body
{"currentPage": 1, "pageSize": 10, "paramType": 1, "param": "test", "status": 0, "osType": 1, "timeType": "LAST_ONE_DAY", "startTime": "2020-01-01 00:00:00", "endTime": "2020-01-01 00:00:00"}
响应示例
{"message": "success", "traceId": "211111111111111111111", "statusCode": "200", "error": "CTCSSCN_000000", "returnObj": {"total": 100, "list": [{"custName": "test-host-name", "displayName": "test-instance-name", "publicIp": "192.168.1.1", "agentIp": "192.168.1.1", "agentGuid": "1234567890", "userName": "test-user-name", "findTime": "2022-06-14 10:00:00", "timestamp": "2022-06-14 10:00:00", "docId": "test-id", "path": "/bin/test.sh", "virusName": "test-virus-name", "severity": "1", "status": 1, "osType": "Linux", "md5": "1234567890", "virusHandleType": "HANDLE", "quotaVersion": 1, "virusType": "普通木马", "pivotalDoc": 0, "sha256": "1234567890", "pid": 1212, "cmd": "/bin/test.sh", "checkModel": 1, "taskId": 1, "checkWay": 1, "handleRules": [{"name": "添加白名单", "label": "ADD_WHITE"}], "whiteData": {"ruleConditionDesc": "告警名称 等于 异常的注册表操作 且 注册表名称 等于 Start 且 注册表路径 等于 \\REGISTRY\\MACHINE\\SYSTEM\\ControlSet001\\Services\\edr_monitor", "rules": [{"fieldValue": "Start", "condition": "=", "fieldEnName": "reg_key", "fieldZnName": "注册表名称", "canEdit": "true"}]}, "eventCategoryId": "2", "eventTypeId": "4400", "virusEngine": "1", "isAutoIsolate": "0"}], "pageNum": 1, "pageSize": 10}}
状态码
请参考 状态码
错误码
请参考 错误码