Enabling Ransomware Prevention

Function

To enable ransomware protection, ensure CBR is available in the region. Ransomware prevention works with CBR.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	User project ID Minimum: 1 Maximum: 256

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 1 Maximum: 256

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. Minimum: 1 Maximum: 32768
region	Yes	String	region id Minimum: 0 Maximum: 128

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
operating_system	Yes	String	OS. Its value can be: Windows Linux Minimum: 0 Maximum: 64
ransom_protection_status	Yes	String	Whether ransomware protection is enabled. Its value can be: closed opened If this parameter is enabled, either protection_policy_id or create_protection_policy must be specified. Minimum: 0 Maximum: 64
protection_policy_id	No	String	Protection policy ID. If you select an existing policy, this parameter is mandatory. Minimum: 0 Maximum: 64
create_protection_policy	No	ProtectionProxyInfoRequestInfo object	Create a protection policy. For a new protection policy, leave protection_policy_id blank and specify create_protection_policy.
backup_protection_status	Yes	String	Whether to back up data on the server. Its value can be: closed opened If server backup is enabled, backup_cycle is mandatory. Minimum: 0 Maximum: 64
backup_resources	No	BackupResources object	This parameter is mandatory when the backup function is enabled. If this parameter is empty, the vault bound to HSS_projectid is compatible.
backup_policy_id	No	String	Backup policy ID Minimum: 0 Maximum: 64
backup_cycle	No	UpdateBackupPolicyRequestInfo1 object	Backup policy.
agent_id_list	Yes	Array of strings	IDs of agents where protection is enabled Minimum: 0 Maximum: 64 Array Length: 0 - 24
host_id_list	Yes	Array of strings	IDs of servers where protection is enabled Minimum: 0 Maximum: 64 Array Length: 0 - 24

**Table 5** ProtectionProxyInfoRequestInfo
Parameter	Mandatory	Type	Description
policy_id	No	String	Policy ID. This parameter is optional for a new policy. Minimum: 0 Maximum: 64
policy_name	No	String	Policy name. This parameter is mandatory when you create a protection policy. Minimum: 0 Maximum: 64
protection_mode	No	String	Protection action. This parameter is mandatory when you create a protection policy. The options are as follows: alarm_and_isolation: Report an alarm and isolate. alarm_only: Only report alarms. Minimum: 0 Maximum: 64
bait_protection_status	No	String	Whether to enable honeypot protection. This parameter is mandatory when you create a protection policy. The options are as follows. By default, honeypot protection is enabled. opened closed Minimum: 0 Maximum: 64
protection_directory	No	String	Protected directory. This parameter is mandatory when you create a protection policy. Minimum: 0 Maximum: 64
protection_type	No	String	Protection type. This parameter is mandatory when you create a protection policy. Minimum: 0 Maximum: 64
exclude_directory	No	String	(Optional) Excluded directory Minimum: 0 Maximum: 64
runtime_detection_status	No	String	(Optional) Whether to perform runtime checks. The options are as follows. Currently, it can only be disabled. This field is reserved. opened closed Minimum: 0 Maximum: 64
operating_system	No	String	OS. This parameter is mandatory when you create a protection policy. Its value can be: Windows Linux Minimum: 0 Maximum: 64
process_whitelist	No	Array of TrustProcessInfo objects	Process whitelist Array Length: 0 - 20

**Table 6** TrustProcessInfo
Parameter	Mandatory	Type	Description
path	No	String	Indicates the process path. Minimum: 0 Maximum: 128
hash	No	String	Process hash Minimum: 0 Maximum: 128

**Table 7** BackupResources
Parameter	Mandatory	Type	Description
vault_id	No	String	Select the ID of the vault to be bound. The value cannot be empty. Minimum: 0 Maximum: 64
resource_list	No	Array of ResourceInfo objects	List of servers for which the backup function needs to be enabled Array Length: 0 - 20

**Table 8** ResourceInfo
Parameter	Mandatory	Type	Description
host_id	No	String	Server ID Minimum: 0 Maximum: 128
history_backup_status	No	String	Whether to enable backup status depends on error_message or status of available servers. If error_message is empty, backup is not enabled and the value of this field is closed. If error_message is not empty, the value of this field is opened. Minimum: 0 Maximum: 128

**Table 9** UpdateBackupPolicyRequestInfo1
Parameter	Mandatory	Type	Description
enabled	No	Boolean	Whether the policy is enabled. The default value is true.
policy_id	No	String	Policy ID. This parameter is mandatory if backup protection is enabled. Minimum: 1 Maximum: 256
operation_definition	No	OperationDefinitionRequestInfo object	Scheduling parameter.
trigger	No	BackupTriggerRequestInfo1 object	Time scheduling rule for the policy.

**Table 10** OperationDefinitionRequestInfo
Parameter	Mandatory	Type	Description
day_backups	No	Integer	Maximum number of retained daily backups. The latest backup of each day is saved in the long term. This parameter is not affected by the maximum number of retained backup. The value ranges from 0 to 100. If this parameter is specified, timezone must be configured. Minimum value: 0. Maximum value: 100 Minimum: 0 Maximum: 100
max_backups	No	Integer	Maximum number of automated backups that can be retained for an object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity limit is exceeded. If this parameter and retention_duration_days are left blank at the same time, the backups will be retained permanently. Minimum value: 1. Maximum value: 99999. Default value: -1 Minimum: -1 Maximum: 99999
month_backups	No	Integer	Maximum number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter is not affected by the maximum number of retained backup. The value ranges from 0 to 100. If this parameter is specified, timezone must be configured. Minimum value: 0. Maximum value: 100 Minimum: 0 Maximum: 100
retention_duration_days	No	Integer	Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared even though the configured retention duration is exceeded. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently. Minimum value: 1. Maximum value: 99999. Default value: -1 Minimum: -1 Maximum: 99999
timezone	No	String	Time zone where the user is located, for example, UTC+08:00. Set this parameter only after you have configured any of the parameters day_backups, week_backups, month_backups, and year_backups. Minimum: 0 Maximum: 256
week_backups	No	Integer	Maximum number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is specified, timezone must be configured. Minimum: 0 Maximum: 100
year_backups	No	Integer	Maximum number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is specified, timezone must be configured. Minimum value: 0. Maximum value: 100 Minimum: 0 Maximum: 100

**Table 11** BackupTriggerRequestInfo1
Parameter	Mandatory	Type	Description
properties	No	BackupTriggerPropertiesRequestInfo1 object	Time rule for policy execution. This parameter is mandatory if the backup function is enabled with ransomware protection.

**Table 12** BackupTriggerPropertiesRequestInfo1
Parameter	Mandatory	Type	Description
pattern	No	Array of strings	Scheduling rule. This parameter is mandatory if the backup function is enabled with ransomware protection. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, or SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. To start scheduling at 14:00 every day, the rule is as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=14;BYMINUTE=00'. Minimum: 1 Maximum: 256 Array Length: 0 - 24

Response Parameters

None

Example Requests

Enable ransomware protection for the server. The OS type is Linux, the target server ID is 71a15ecc-049f-4cca-bd28-5e90aca1817f, and the agent ID of the target server is c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8. Server backup is disabled.

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"
  }
}