文档首页/ 企业主机安全 HSS/ API参考（吉隆坡区域）/ API说明/ 勒索防护/ 查询防护策略列表
更新时间：2025-09-23 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询防护策略列表

功能介绍

查询防护策略列表

URI

GET /v5/{project_id}/ransomware/protection/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目ID，查询所有企业项目时填写：all_granted_eps

offset

否

Integer

偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0

limit

否

Integer

每页显示个数

policy_name

否

String

防护策略名称

protect_policy_id

否

String

防护策略id

operating_system

否

String

策略支持的操作系统

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

是

String

用户Token。

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

data_list

Array of ProtectionPolicyInfo objects

查询防护策略列表
表5 ProtectionPolicyInfo

参数

参数类型

描述

policy_id

String

策略ID

policy_name

String

策略名称

protection_mode

String

防护动作，包含如下2种。

  • alarm_and_isolation ：告警并自动隔离。

  • alarm_only ：仅告警。

bait_protection_status

String

是否开启诱饵防护，包含如下1种, 默认为开启防护诱饵防护。

  • opened ：开启。

  • closed ：关闭。

deploy_mode

String

是否开启动态诱饵防护，包含如下2种, 默认为关闭动态诱饵防护。

  • opened ：开启。

  • closed ：关闭。

protection_directory

String

防护目录

protection_type

String

防护文件类型

exclude_directory

String

排除目录，选填

runtime_detection_status

String

是否运行时检测，包含如下2种，暂时只有关闭一种状态，为保留字段。

  • opened ：开启。

  • closed ：关闭。

runtime_detection_directory

String

运行时检测目录，所有目录是/,现在为保留字段

count_associated_server

Integer

关联server个数

operating_system

String

操作系统类型

process_whitelist

Array of TrustProcessInfo objects

进程白名单

default_policy

Integer

是否为默认策略，包含如下2种。

  • 0 ：非默认策略。

  • 1 ：默认策略
表6 TrustProcessInfo

参数

参数类型

描述

path

String

进程路径

hash

String

进程hash

请求示例

查询防护策略列表，不传limit参数默认返回10条数据。

GET https://{endpoint}/v5/{project_id}/ransomware/protection/policy

响应示例

状态码：200

防护策略列表

{
  "total_num" : 1,
  "data_list" : [ {
    "bait_protection_status" : "opened",
    "exclude_directory" : "/opt",
    "count_associated_server" : 0,
    "operating_system" : "Linux",
    "protection_mode" : "alarm_only",
    "policy_id" : "4117d16-074b-41ae-b7d7-9cc25ee258",
    "policy_name" : "test",
    "protection_directory" : "/dd",
    "protection_type" : "docx",
    "runtime_detection_status" : "closed"
  } ]
}

状态码

状态码

描述

200

防护策略列表

错误码

请参见错误码。

父主题： 勒索防护