更新时间:2025-09-23 GMT+08:00

开启勒索病毒防护

功能介绍

开启勒索病毒防护,请保证该region有cbr云备份服务,勒索服务与云备份服务有关联关系

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,查询所有企业项目时填写:all_granted_eps

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

String

用户Token。

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

表4 请求Body参数

参数

是否必选

参数类型

描述

operating_system

String

操作系统,包含如下:

  • Windows : Windows系统

  • Linux : Linux系统

ransom_protection_status

String

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

  • closed :关闭。

  • opened :开启。

若选择开启,protection_policy_id或者create_protection_policy必填一项

protection_policy_id

String

防护策略ID,若选择已有策略防护,则该字段必选

create_protection_policy

ProtectionProxyInfoRequestInfo object

创建防护策略。若新建防护策略,则protection_policy_id为空,create_protection_policy必选

backup_protection_status

String

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

  • closed :关闭。

  • opened :开启。

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

backup_resources

BackupResources object

开启备份功能新版参数,必填;若为空代表兼容之前绑定HSS_projectid的存储库

backup_policy_id

String

备份策略ID

backup_cycle

UpdateBackupPolicyRequestInfo1 object

备份策略

agent_id_list

Array of strings

开启防护的Agent id列表

host_id_list

Array of strings

开启防护的host id列表

表5 ProtectionProxyInfoRequestInfo

参数

是否必选

参数类型

描述

policy_id

String

策略ID,新建策略可不填

policy_name

String

策略名称,新建防护策略则必填

protection_mode

String

防护动作,新建防护策略则必填。包含如下:

  • alarm_and_isolation :告警并自动隔离。

  • alarm_only :仅告警。

bait_protection_status

String

是否开启诱饵防护,新建防护策略则必填。包含如下1种, 默认为开启防护诱饵防护。

  • opened :开启。

  • closed :关闭。

protection_directory

String

防护目录,新建防护策略则必填

protection_type

String

防护类型,新建防护策略则必填

exclude_directory

String

排除目录,可选填

runtime_detection_status

String

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

  • opened :开启。

  • closed :关闭。

operating_system

String

操作系统,新建防护策略则必填。包含如下:

  • Windows : Windows系统

  • Linux : Linux系统

process_whitelist

Array of TrustProcessInfo objects

进程白名单

表6 TrustProcessInfo

参数

是否必选

参数类型

描述

path

String

进程路径

hash

String

进程hash

表7 BackupResources

参数

是否必选

参数类型

描述

vault_id

String

选择需要绑定的存储库ID,不为空

resource_list

Array of ResourceInfo objects

需要开启备份功能的主机情况列表

表8 ResourceInfo

参数

是否必选

参数类型

描述

host_id

String

主机id

history_backup_status

String

历史开启备份状态,通过筛选可用服务器的error_message或者status判断,如果error_message为空,则没有开启备份,该字段为closed;若不为空,则为opened

表9 UpdateBackupPolicyRequestInfo1

参数

是否必选

参数类型

描述

enabled

Boolean

策略是否启用,缺省值:true

policy_id

String

策略ID,若开启防护时开启备份防护,该字段必选

operation_definition

OperationDefinitionRequestInfo object

调度参数

trigger

BackupTriggerRequestInfo1 object

策略时间调度规则

表10 OperationDefinitionRequestInfo

参数

是否必选

参数类型

描述

day_backups

Integer

保留日备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。最小值:0,最大值:100

max_backups

Integer

单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空,备份会永久保留。最小值:1,最大值:99999,缺省值:-1

month_backups

Integer

保留月备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。最小值:0, 最大值:100

retention_duration_days

Integer

备份保留时长,单位天。最长支持99999天。-1代表不按时间清理。若该字段和max_backups 参数同时为空,备份会永久保留。最小值:1, 最大值:99999, 缺省值:-1

timezone

String

用户所在时区,格式形如UTC+08:00,若没有选择年备,月备,周备,日备中任一参数,则不能选择该参数。

week_backups

Integer

保留周备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。

year_backups

Integer

保留年备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。最小值:0,最大值:100

表11 BackupTriggerRequestInfo1

参数

是否必选

参数类型

描述

properties

BackupTriggerPropertiesRequestInfo1 object

策略执行时间规则,若开启勒索防护时开启备份功能,则该字段必选

表12 BackupTriggerPropertiesRequestInfo1

参数

是否必选

参数类型

描述

pattern

Array of strings

调度规则。若开启勒索防护时开启备份功能,则该字段必选。限制24条规则。调度器的调度规则,可参照iCalendar RFC 2445规范中的事件规则,但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE、INTERVAL等参数,其中FREQ仅支持WEEKLY和DAILY,BYDAY支持一周七天(MO、TU、WE、TH、FR、SA、SU),BYHOUR支持0-23小时,BYMINUTE支持0-59分钟,并且间隔不能小于一小时,一天最大24个时间点。例如,周一到周天,每天14:00调度,其规则为:'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。每天14:00调度,其规则为'FREQ=DAILY;INTERVAL=1;BYHOUR=14;BYMINUTE=00'。

响应参数

状态码:200

开启勒索病毒防护成功

请求示例

开启服务器勒索病毒防护,目标服务器操作系统类型为Linux,目标服务器ID为71a15ecc-049f-4cca-bd28-5e90aca1817f,目标服务器的Agent ID为c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8,不开启服务器备份。

POST https://{endpoint}/v5/{project_id}/ransomware/protection/open

{
  "ransom_protection_status" : "opened",
  "backup_protection_status" : "closed",
  "operating_system" : "Linux",
  "protection_policy_id" : "",
  "agent_id_list" : [ "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8" ],
  "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ],
  "create_protection_policy" : {
    "bait_protection_status" : "opened",
    "exclude_directory" : "",
    "protection_mode" : "alarm_only",
    "policy_name" : "test111",
    "protection_directory" : "/etc/test",
    "protection_type" : "docx"
  }
}

响应示例

状态码

状态码

描述

200

开启勒索病毒防护成功

错误码

请参见错误码