文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 勒索防护/ 修改勒索防护策略 - UpdateProtectionPolicy
更新时间:2025-10-31 GMT+08:00
分享

修改勒索防护策略 - UpdateProtectionPolicy

功能介绍

修改勒索防护策略

授权信息

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

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

URI

PUT /v5/{project_id}/ransomware/protection/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)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

policy_id

String

参数解释:

需要修改的防护策略ID,您可以通过查询勒索病毒的防护策略列表接口获取ID。

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

policy_name

String

参数解释:

策略名称

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

protection_mode

String

参数解释:

防护动作

约束限制:

不涉及

取值范围:

包含两种:

  • alarm_and_isolation :告警并自动隔离。

  • alarm_only :仅告警。

默认取值:

不涉及

bait_protection_status

String

参数解释:

是否开启诱饵防护

约束限制:

不涉及

取值范围:

  • opened :开启。

默认取值:

不涉及

deploy_mode

String

参数解释:

是否开启动态诱饵

约束限制:

不涉及

取值范围:

包含两种:

  • opened :开启。

  • closed :关闭。

默认取值:

closed

protection_directory

String

参数解释:

防护目录

约束限制:

多个目录请用英文分号隔开,最多支持填写20个防护目录

取值范围:

字符长度0-128位,特殊符号只允许使用._-+,不能以空格开头,防护目录长度不得超过256个字符。

默认取值:

不涉及

protection_type

String

参数解释:

需要防护的文件类型

约束限制:

不涉及

取值范围:

txt、csv、rtf、doc、docx、xls、xlsx、ppt、pptx、pdf、xml、json、sql、mdf、dbf、ldf、db、myd、wdb、si、cfs、cfe、fnm、fdx、fdt、tvx、tvf、tvd、tim、nvd、nvm、dvd、dvm、jpeg、bmp、gif、png、tiff、eps、mp3、mp4、avi、mpg、wmv、RMVB、mov、3pg、swf、flv、rar、gz、tgz、zip、7z、cpp、c、java、asp、php、python、html、js、vdi、vmdk、vdx、ovf、qcow2、vmem、vswp、img、bak、back、cer、crt、pem、key、csr

默认取值:

不涉及

exclude_directory

String

参数解释:

排除目录(选填)

约束限制:

多个目录请用英文分号隔开,最多支持填写20个排除目录

取值范围:

字符长度0-128位,特殊符号只允许使用._-+,不能以空格开头,防护目录长度不得超过256个字符。

默认取值:

不涉及

agent_id_list

Array of strings

参数解释:

开启了此勒索防护策略的agent的id列表

约束限制:

不涉及

取值范围:

列表最大1000条

默认取值:

不涉及

operating_system

String

参数解释:

支持该策略的操作系统

约束限制:

不涉及

取值范围:

包含两种:

  • Windows : Windows系统

  • Linux : Linux系统

默认取值:

不涉及

runtime_detection_status

String

参数解释:

是否运行时检测

约束限制:

不涉及

取值范围:

包含如下2种,暂时只有关闭一种状态,为保留字段。

  • opened :开启。

  • closed :关闭。

默认取值:

不涉及

process_whitelist

Array of TrustProcessInfo objects

进程白名单

ai_protection_status

String

参数解释:

是否开启AI勒索防护

约束限制:

不涉及

取值范围:

包含两种:

  • opened :开启。

  • closed :关闭。

默认取值:

不涉及

表5 TrustProcessInfo

参数

是否必选

参数类型

描述

path

String

参数解释:

进程路径

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

hash

String

参数解释:

进程hash

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

响应参数

状态码:200

请求已成功

请求示例

修改勒索病毒防护策略,目标服务器操作系统类型为Linux,防护策略ID为0253edfd-30e7-439d-8f3f-17c54c997064,防护动作为仅告警。

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

{
  "bait_protection_status" : "opened",
  "protection_type" : "docx",
  "exclude_directory" : "",
  "operating_system" : "Linux",
  "policy_id" : "0253edfd-30e7-439d-8f3f-17c54c997064",
  "policy_name" : "aaa",
  "protection_mode" : "alarm_only",
  "protection_directory" : "/root",
  "runtime_detection_status" : "closed",
  "agent_id_list" : [ "" ]
}

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档