文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 白名单管理/ 查询告警白名单列表 - ListAlarmWhiteList
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

查询告警白名单列表 - ListAlarmWhiteList

功能介绍

查询告警白名单列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/event/white-list/alarm

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

主机所属的企业项目ID。

开通企业项目功能后才需要配置企业项目。

企业项目ID默认取值为“0”，表示默认企业项目。如果需要查询所有企业项目下的主机，请传参“all_granted_eps”。如果您只有某个企业项目的权限，则需要传递该企业项目ID，查询该企业项目下的主机，否则会因权限不足而报错。

hash

否

String

事件白名单SHA256

event_type

否

Integer

事件类型，包含如下:

  • 1001：通用恶意软件

  • 1002：病毒

  • 1003：蠕虫

  • 1004：木马

  • 1005：僵尸网络

  • 1006：后门

  • 1010：Rootkit

  • 1011：勒索软件

  • 1012：黑客工具

  • 1015：Webshell

  • 1016：挖矿

  • 1017：反弹Shell

  • 2001：一般漏洞利用

  • 2012：远程代码执行

  • 2047：Redis漏洞利用

  • 2048：Hadoop漏洞利用

  • 2049：MySQL漏洞利用

  • 3002：文件提权

  • 3003：进程提权

  • 3004：关键文件变更

  • 3005：文件/目录变更

  • 3007：进程异常行为

  • 3015：高危命令执行

  • 3018：异常Shell

  • 3027：Crontab可疑任务

  • 3029：系统安全防护被禁用

  • 3030：备份删除

  • 3031：异常注册表操作

  • 3036：容器镜像阻断

  • 4002：暴力破解

  • 4004：异常登录

  • 4006：非法系统账号

  • 4014：用户账号添加

  • 4020：用户密码窃取

  • 6002：端口扫描

  • 6003：主机扫描

  • 13001：Kubernetes事件删除

  • 13002：Pod异常行为

  • 13003：枚举用户信息

  • 13004：绑定集群用户角色

offset

否

Integer

偏移量：指定返回记录的开始位置

limit

否

Integer

每页显示个数

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

region

否

String

Region ID

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

总数

取值范围:

最小值0，最大值2147483647

remain_num

Integer

可继续添加的白名单数量

limit_num

Integer

白名单数量上限

event_type_list

Array of integers

支持筛选的事件类型

data_list

Array of AlarmWhiteListResponseInfo objects

告警白名单详情
表5 AlarmWhiteListResponseInfo

参数

参数类型

描述

enterprise_project_name

String

企业项目名称

hash

String

参数解释:

事件白名单SHA256

约束限制:

不涉及

取值范围:

字符长度0-512位

默认取值:

不涉及

description

String

参数解释:

描述信息。

约束限制:

不涉及

取值范围:

字符长度0-64

默认取值:

不涉及

event_type

Integer

参数解释：

事件类型

取值范围：

  • 1001：通用恶意软件

  • 1002：病毒

  • 1003：蠕虫

  • 1004：木马

  • 1005：僵尸网络

  • 1006：后门

  • 1010：Rootkit

  • 1011：勒索软件

  • 1012：黑客工具

  • 1015：Webshell

  • 1016：挖矿

  • 1017：反弹Shell

  • 2001：一般漏洞利用

  • 2012：远程代码执行

  • 2047：Redis漏洞利用

  • 2048：Hadoop漏洞利用

  • 2049：MySQL漏洞利用

  • 3002：文件提权

  • 3003：进程提权

  • 3004：关键文件变更

  • 3005：文件/目录变更

  • 3007：进程异常行为

  • 3015：高危命令执行

  • 3018：异常Shell

  • 3027：Crontab可疑任务

  • 3029：系统安全防护被禁用

  • 3030：备份删除

  • 3031：异常注册表操作

  • 3036：容器镜像阻断

  • 4002：暴力破解

  • 4004：异常登录

  • 4006：非法系统账号

  • 4014：用户账号添加

  • 4020：用户密码窃取

  • 6002：端口扫描

  • 6003：主机扫描

  • 13001：Kubernetes事件删除

  • 13002：Pod异常行为

  • 13003：枚举用户信息

  • 13004：绑定集群用户角色

white_field

String

加白字段，包含如下:

  • "file/process hash" # 进程/文件hash

  • "file_path" # 文件路径

  • "process_path" # 进程路径

  • "login_ip" # 登录ip

  • "reg_key" #注册表key

  • "process_cmdline" # 进程命令行

  • "username" # 用户名

field_value

String

加白字段值

judge_type

String

通配符，包含如下:

  • "equal" # 相等

  • "contain" # 包含

update_time

Long

事件白名单更新时间，毫秒

请求示例

查询前10条企业项目为xxx下的告警白名单列表

GET https://{endpoint}/v5/{project_id}/event/white-list/alarm?limit=10&offset=0&enterprise_project_id=xxx

响应示例

状态码：200

请求已成功

{
  "data_list" : [ {
    "enterprise_project_name" : "所有项目",
    "event_type" : 1001,
    "hash" : "9ab079e5398cba3a368ccffbd478f54c5ec3edadf6284ec049a73c36419f1178",
    "description" : "/opt/cloud/3rdComponent/install/jre-8u201/bin/java",
    "update_time" : 1665715677307,
    "white_field" : "process/file hash",
    "judge_type" : "contain",
    "field_value" : "abcd12345612311112212323"
  } ],
  "event_type_list" : [ 1001 ],
  "total_num" : 1
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 白名单管理

相关文档