文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 应用进程控制/ 查询进程白名单策略列表 - ListAppWhitelistPolicy
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

查询进程白名单策略列表 - ListAppWhitelistPolicy

功能介绍

查询进程白名单策略列表

授权信息

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

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

URI

GET /v5/{project_id}/app/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释:

企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

0，表示默认企业项目（default）。

offset

是

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

最小值0，最大值2000000

默认取值:

不涉及

limit

是

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

policy_name

否

String

策略名称

policy_type

否

String

参数解释：

进程白名单策略类型

约束限制:

不涉及

取值范围:

  • block：日常运营模式

默认取值:

不涉及

learning_status

否

String

参数解释：

策略学习状态

约束限制:

不涉及

取值范围:

  • effecting：学习完成，策略生效

  • learned：学习完成，待确认

  • learning：学习中

  • pause：暂停

  • abnormal：学习异常

默认取值:

不涉及

intercept

否

Boolean

参数解释：

是否开启阻断

约束限制:

不涉及

取值范围:

  • true：是

  • false：否

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data_list

Array of AppWhitelistPolicyResponseInfo objects

data list

total_num

Integer

参数解释:

总数

取值范围:

最小值0，最大值2147483647
表5 AppWhitelistPolicyResponseInfo

参数

参数类型

描述

policy_id

String

策略ID

policy_name

String

策略名称

policy_type

String

参数解释：

进程白名单策略类型

取值范围:

  • block：日常运营模式

learning_status

String

参数解释：

学习状态

约束限制:

不涉及

取值范围:

  • effecting：学习完成，策略生效

  • learned：学习完成，待确认

  • learning：学习中

  • pause：暂停

  • abnormal：学习异常

默认取值:

不涉及

learning_days

Integer

参数解释:

策略学习天数

取值范围:

最小值3，最大值30

specified_dir

Boolean

参数解释：

是否指定学习目录

约束限制：

不涉及

取值范围:

  • true：是

  • false：否

默认取值：

不涉及

dir_list

Array of strings

监控目录列表

file_extension_list

Array of strings

监控文件后缀名列表

intercept

Boolean

参数解释：

是否开启阻断

取值范围:

  • true：是

  • false：否

auto_detect

Boolean

参数解释：

是否自动开启检测

取值范围:

  • true：是

  • false：否

not_effect_host_num

Integer

参数解释:

学习完成策略未生效主机数

取值范围:

最小值0，最大值2147483647

effect_host_num

Integer

参数解释:

学习完成策略已生效主机数

取值范围:

最小值0，最大值2147483647

trust_num

Integer

参数解释:

识别可信进程数

取值范围:

最小值0，最大值2147483647

suspicious_num

Integer

参数解释:

识别可疑进程数

取值范围:

最小值0，最大值2147483647

malicious_num

Integer

参数解释:

识别恶意进程数

取值范围:

最小值0，最大值2147483647

unknown_num

Integer

参数解释:

识别未知进程数

取值范围:

最小值0，最大值2147483647

abnormal_info_list

Array of AppWhitelistAbnormalInfo objects

学习异常原因列表

auto_confirm

Boolean

参数解释：

是否自动确认学习结果

取值范围:

  • true：是

  • false：否

default_policy

Boolean

参数解释：

默认进程白名单策略

取值范围:

  • true：是

  • false：否

host_id_list

Array of strings

主机id集合
表6 AppWhitelistAbnormalInfo

参数

参数类型

描述

abnormal_type

Integer

异常类型

abnormal_description

String

异常描述

请求示例

无

响应示例

状态码：200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "policy_id" : "e208b***-f2e8-48bf-a9fe-a8******d900",
    "policy_name" : "app_whitelist_20250117161121",
    "policy_type" : "block",
    "learning_status" : "learning",
    "learning_days" : 7,
    "specified_dir" : false,
    "intercept" : false,
    "trust_num" : 0,
    "suspicious_num" : 0,
    "malicious_num" : 0,
    "unknown_num" : 0,
    "effect_host_num" : 0,
    "not_effect_host_num" : 1,
    "auto_detect" : true,
    "host_id_list" : [ "a241d890-34cb-4747-bce8-2a5f35df67bd" ],
    "default_policy" : false,
    "auto_confirm" : true
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 应用进程控制

相关文档