文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 勒索防护/ 批量开启勒索病毒防护2.0 - BatchStartProtection
更新时间:2025-10-31 GMT+08:00
分享

批量开启勒索病毒防护2.0 - BatchStartProtection

功能介绍

批量开启勒索病毒防护,若开启备份防护,请保证该region有cbr云备份服务

授权信息

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

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

URI

POST /v5/{project_id}/ransomware/protection/batch-open

表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位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

operating_system

String

操作系统,包含如下:

  • Windows : Windows系统

  • Linux : Linux系统

ransom_protection_status

String

勒索防护是否开启,包含如下:

  • closed :关闭。

  • opened :开启。

若选择开启,protection_policy_id必填一项

protection_policy_id

String

防护策略ID,若ransom_protection_status为opened,则该字段必选

backup_protection_status

String

是否服务器备份,包含如下:

  • closed :关闭。

  • opened :开启。

若选择开启服务器备份,则vault_id必填

vault_id

String

需要绑定的存储库ID,若backup_protection_status为opened,则该字段必填

host_id_list

Array of strings

开启防护的host id列表

响应参数

状态码:200

请求已成功

请求示例

开启服务器勒索病毒防护,目标服务器操作系统类型为Linux,目标服务器ID为71a15ecc-049f-4cca-bd28-5e90aca1817f,防护策略id为d6439f9b-4407-3ebd-a14d-26b2e625fe17,不开启服务器备份。

{
  "ransom_protection_status" : "opened",
  "backup_protection_status" : "closed",
  "operating_system" : "Linux",
  "protection_policy_id" : "d6439f9b-4407-3ebd-a14d-26b2e625fe17",
  "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ]
}

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档