开启勒索病毒防护 - StartProtection

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位。

默认取值:

不涉及

enterprise_project_id

否

String

参数解释:

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

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

约束限制:

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

取值范围:

字符长度1-256位

默认取值:

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

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

operating_system

是

String

参数解释:

策略支持的操作系统

约束限制:

不涉及

取值范围:

包含如下：

• Windows : Windows系统

• Linux : Linux系统

默认取值:

不涉及

ransom_protection_status

是

String

参数解释:

勒索防护是否开启，若开启勒索病毒防护，则必填protection_policy_id或者create_protection_policy其中一项。

约束限制:

不涉及

取值范围:

包含如下：

• closed ：关闭。

• opened ：开启。

默认取值:

不涉及

protection_policy_id

否

String

参数解释:

勒索防护策略ID，若开启勒索防护，选择已有策略防护，则该字段必选。

约束限制:

不涉及

取值范围:

字符长度0-64

默认取值:

不涉及

create_protection_policy

否

ProtectionProxyInfoRequestInfo object

参数解释:

创建防护策略。若开启勒索防护，新建防护策略，则protection_policy_id为空，create_protection_policy必选

约束限制:

不涉及

取值范围:

字符长度0-64位

默认取值:

不涉及

backup_protection_status

是

String

参数解释:

是否服务器备份，若选择开启服务器备份，则backup_cycle必填

约束限制:

不涉及

取值范围:

包含如下：

• closed ：关闭。

• opened ：开启。

默认取值:

不涉及

backup_resources

否

BackupResources object

参数解释:

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

约束限制:

不涉及

取值范围:

取值0-20个BackupResources对象

默认取值:

不涉及

backup_policy_id

否

String

参数解释:

备份策略ID

约束限制:

不涉及

取值范围:

字符长度0-64

默认取值:

不涉及

backup_cycle

否

UpdateBackupPolicyRequestInfo1 object

备份策略

agent_id_list

是

Array of strings

参数解释:

开启防护的Agent id列表

约束限制:

不涉及

取值范围:

列表条数0-64

默认取值:

不涉及

host_id_list

是

Array of strings

参数解释:

开启防护的host id列表

约束限制:

不涉及

取值范围:

列表条数0-64

默认取值:

不涉及

policy_id

否

String

参数解释:

策略ID，新建策略可不填。

约束限制:

不涉及

取值范围:

字符长度0-64

默认取值:

不涉及

policy_name

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度0-64

默认取值:

不涉及

protection_mode

否

String

参数解释:

防护动作，新建防护策略则必填

约束限制:

不涉及

取值范围:

包含如下：

• alarm_and_isolation ：告警并自动隔离。

• alarm_only ：仅告警。

默认取值:

不涉及

bait_protection_status

否

String

参数解释:

是否开启诱饵防护，新建防护策略则必填。

约束限制:

不涉及

取值范围:

包含如下1种：

• opened ：开启。

默认取值:

不涉及

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个字符。

默认取值:

不涉及

runtime_detection_status

否

String

参数解释:

是否运行时检测

约束限制:

不涉及

取值范围:

暂时只有关闭一种状态，为预留字段。

• closed ：关闭。

默认取值:

不涉及

operating_system

否

String

参数解释:

支持该策略的操作系统，新建防护策略则必填

约束限制:

不涉及

取值范围:

包含两种：

• Windows : Windows系统

• Linux : Linux系统

默认取值:

不涉及

process_whitelist

否

Array of TrustProcessInfo objects

进程白名单

path

否

String

参数解释:

进程路径

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

hash

否

String

参数解释:

进程hash

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

vault_id

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度0-64

默认取值:

不涉及

resource_list

否

Array of ResourceInfo objects

参数解释:

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

约束限制:

不涉及

取值范围:

取值0-20条主机id

默认取值:

不涉及

host_id

否

String

参数解释:

主机id

约束限制:

不涉及

取值范围:

字符长度0-128

默认取值:

不涉及

history_backup_status

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

• closed：关闭备份

• opened：开启备份

默认取值:

不涉及

enabled

否

Boolean

参数解释:

策略是否启用

约束限制:

不涉及

取值范围:

• true：策略已启用

• false：策略未启用

默认取值:

true

policy_id

否

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256

默认取值:

不涉及

operation_definition

否

OperationDefinitionRequestInfo object

参数解释:

调度参数

约束限制:

不涉及

取值范围:

取值为0到100。

默认取值:

不涉及

trigger

否

BackupTriggerRequestInfo1 object

参数解释:

策略时间调度规则。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

day_backups

否

Integer

参数解释:

保留日备个数，该备份不受保留最大备份数限制。若选择该参数，则timezone也必选。

约束限制:

不涉及

取值范围:

取值为0到100。

默认取值:

不涉及

max_backups

否

Integer

参数解释:

单个备份对象自动备份的最大备份数。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空，备份会永久保留。

约束限制:

不涉及

取值范围:

取值为-1或1-99999

默认取值:

-1

month_backups

否

Integer

参数解释:

保留月备个数，该备份不受保留最大备份数限制。若选择该参数，则timezone也必选。

约束限制:

不涉及

取值范围:

取值为0到100。

默认取值:

不涉及

retention_duration_days

否

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

取值范围-1-99999

默认取值:

-1

timezone

否

String

参数解释:

用户所在时区，格式形如UTC+08:00

约束限制:

若没有选择年备，月备，周备，日备中任一参数，则不能选择该参数。

取值范围:

• UTC+05:00

• UTC+06:00

• UTC+07:00

...

默认取值:

不涉及

week_backups

否

Integer

参数解释:

保留周备个数，该备份不受保留最大备份数限制。若选择该参数，则timezone也必选。

约束限制:

不涉及

取值范围:

取值为0到100。

默认取值:

不涉及

year_backups

否

Integer

参数解释:

保留年备个数，该备份不受保留最大备份数限制。若选择该参数，则timezone也必选。

约束限制:

不涉及

取值范围:

取值为0到100。

默认取值:

不涉及

properties

否

BackupTriggerPropertiesRequestInfo1 object

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

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

请求已成功