开启勒索病毒防护
功能介绍
开启勒索病毒防护,请保证该region有cbr云备份服务,勒索服务与云备份服务有关联关系
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/ransomware/protection/open
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:1 最大长度:256 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目ID,查询所有企业项目时填写:all_granted_eps 缺省值:0 最小长度:1 最大长度:256 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:1 最大长度:32768 |
region |
是 |
String |
Region ID 最小长度:0 最大长度:128 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
operating_system |
是 |
String |
需要开启防护的主机的操作系统,包含如下:
最小长度:0 最大长度:64 |
ransom_protection_status |
是 |
String |
勒索防护是否开启,包含如下:
最小长度:0 最大长度:64 |
protection_policy_id |
否 |
String |
勒索防护策略ID,若选择已有策略防护,则该字段必选 最小长度:0 最大长度:64 |
create_protection_policy |
否 |
创建防护策略。若新建防护策略,则protection_policy_id为空,create_protection_policy必选 |
|
backup_protection_status |
是 |
String |
是否服务器备份,包含如下:
最小长度:0 最大长度:64 |
backup_resources |
否 |
BackupResources object |
开启备份功能新版参数,必填;若为空代表兼容之前绑定HSS_projectid的存储库 |
backup_policy_id |
否 |
String |
备份策略ID 最小长度:0 最大长度:64 |
backup_cycle |
否 |
备份策略 |
|
agent_id_list |
是 |
Array of strings |
开启防护的Agent id列表 最小长度:0 最大长度:64 数组长度:0 - 24 |
host_id_list |
是 |
Array of strings |
开启防护的host id列表 最小长度:0 最大长度:64 数组长度:0 - 24 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
policy_id |
否 |
String |
策略ID,新建策略可不填 最小长度:0 最大长度:64 |
policy_name |
否 |
String |
策略名称,新建防护策略则必填 最小长度:0 最大长度:64 |
protection_mode |
否 |
String |
防护动作,新建防护策略则必填。包含如下:
最小长度:0 最大长度:64 |
bait_protection_status |
否 |
String |
是否开启诱饵防护,新建防护策略则必填。包含如下1种, 默认为开启防护诱饵防护。
最小长度:0 最大长度:64 |
protection_directory |
否 |
String |
防护目录,新建防护策略则必填 最小长度:0 最大长度:64 |
protection_type |
否 |
String |
防护类型,新建防护策略则必填 最小长度:0 最大长度:64 |
exclude_directory |
否 |
String |
排除目录,可选填 最小长度:0 最大长度:64 |
runtime_detection_status |
否 |
String |
是否运行时检测,选填。包含如下2种,暂时只有关闭一种状态,为保留字段。
最小长度:0 最大长度:64 |
operating_system |
否 |
String |
操作系统,新建防护策略则必填。包含如下:
最小长度:0 最大长度:64 |
process_whitelist |
否 |
Array of TrustProcessInfo objects |
进程白名单 数组长度:0 - 20 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
path |
否 |
String |
进程路径 最小长度:0 最大长度:128 |
hash |
否 |
String |
进程hash 最小长度:0 最大长度:128 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
vault_id |
否 |
String |
选择需要绑定的存储库ID,不为空 最小长度:0 最大长度:64 |
resource_list |
否 |
Array of ResourceInfo objects |
需要开启备份功能的主机情况列表 数组长度:0 - 20 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
host_id |
否 |
String |
主机id 最小长度:0 最大长度:128 |
history_backup_status |
否 |
String |
历史开启备份状态,通过筛选可用服务器的error_message或者status判断,如果error_message为空,则没有开启备份,该字段为closed;若不为空,则为opened 最小长度:0 最大长度:128 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enabled |
否 |
Boolean |
策略是否启用,缺省值:true |
policy_id |
否 |
String |
策略ID,若开启防护时开启备份防护,该字段必选 最小长度:1 最大长度:256 |
operation_definition |
否 |
调度参数 |
|
trigger |
否 |
BackupTriggerRequestInfo1 object |
策略时间调度规则 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
day_backups |
否 |
Integer |
保留日备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。最小值:0,最大值:100 最小值:0 最大值:100 |
max_backups |
否 |
Integer |
单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空,备份会永久保留。最小值:1,最大值:99999,缺省值:-1 最小值:-1 最大值:99999 |
month_backups |
否 |
Integer |
保留月备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。最小值:0, 最大值:100 最小值:0 最大值:100 |
retention_duration_days |
否 |
Integer |
备份保留时长,单位天。最长支持99999天。-1代表不按时间清理。若该字段和max_backups 参数同时为空,备份会永久保留。最小值:1, 最大值:99999, 缺省值:-1 最小值:-1 最大值:99999 |
timezone |
否 |
String |
用户所在时区,格式形如UTC+08:00,若没有选择年备,月备,周备,日备中任一参数,则不能选择该参数。 最小长度:0 最大长度:256 |
week_backups |
否 |
Integer |
保留周备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。 最小值:0 最大值:100 |
year_backups |
否 |
Integer |
保留年备个数,该备份不受保留最大备份数限制。取值为0到100。若选择该参数,则timezone 也必选。最小值:0,最大值:100 最小值:0 最大值:100 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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'。 最小长度:1 最大长度:256 数组长度:0 - 24 |
响应参数
无
请求示例
开启服务器勒索病毒防护,目标服务器操作系统类型为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" } }
响应示例
无
SDK代码示例
SDK代码示例如下。
开启服务器勒索病毒防护,目标服务器操作系统类型为Linux,目标服务器ID为71a15ecc-049f-4cca-bd28-5e90aca1817f,目标服务器的Agent ID为c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8,不开启服务器备份。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; import java.util.List; import java.util.ArrayList; public class StartProtectionSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); StartProtectionRequest request = new StartProtectionRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); ProtectionInfoRequestInfo body = new ProtectionInfoRequestInfo(); List<String> listbodyHostIdList = new ArrayList<>(); listbodyHostIdList.add("71a15ecc-049f-4cca-bd28-5e90aca1817f"); List<String> listbodyAgentIdList = new ArrayList<>(); listbodyAgentIdList.add("c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8"); ProtectionProxyInfoRequestInfo createProtectionPolicybody = new ProtectionProxyInfoRequestInfo(); createProtectionPolicybody.withPolicyName("test111") .withProtectionMode("alarm_only") .withBaitProtectionStatus("opened") .withProtectionDirectory("/etc/test") .withProtectionType("docx") .withExcludeDirectory(""); body.withHostIdList(listbodyHostIdList); body.withAgentIdList(listbodyAgentIdList); body.withBackupProtectionStatus("closed"); body.withCreateProtectionPolicy(createProtectionPolicybody); body.withProtectionPolicyId(""); body.withRansomProtectionStatus("opened"); body.withOperatingSystem("Linux"); request.withBody(body); try { StartProtectionResponse response = client.startProtection(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
开启服务器勒索病毒防护,目标服务器操作系统类型为Linux,目标服务器ID为71a15ecc-049f-4cca-bd28-5e90aca1817f,目标服务器的Agent ID为c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8,不开启服务器备份。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = StartProtectionRequest() request.enterprise_project_id = "<enterprise_project_id>" listHostIdListbody = [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ] listAgentIdListbody = [ "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8" ] createProtectionPolicybody = ProtectionProxyInfoRequestInfo( policy_name="test111", protection_mode="alarm_only", bait_protection_status="opened", protection_directory="/etc/test", protection_type="docx", exclude_directory="" ) request.body = ProtectionInfoRequestInfo( host_id_list=listHostIdListbody, agent_id_list=listAgentIdListbody, backup_protection_status="closed", create_protection_policy=createProtectionPolicybody, protection_policy_id="", ransom_protection_status="opened", operating_system="Linux" ) response = client.start_protection(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
开启服务器勒索病毒防护,目标服务器操作系统类型为Linux,目标服务器ID为71a15ecc-049f-4cca-bd28-5e90aca1817f,目标服务器的Agent ID为c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8,不开启服务器备份。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.StartProtectionRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest var listHostIdListbody = []string{ "71a15ecc-049f-4cca-bd28-5e90aca1817f", } var listAgentIdListbody = []string{ "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8", } policyNameCreateProtectionPolicy:= "test111" protectionModeCreateProtectionPolicy:= "alarm_only" baitProtectionStatusCreateProtectionPolicy:= "opened" protectionDirectoryCreateProtectionPolicy:= "/etc/test" protectionTypeCreateProtectionPolicy:= "docx" excludeDirectoryCreateProtectionPolicy:= "" createProtectionPolicybody := &model.ProtectionProxyInfoRequestInfo{ PolicyName: &policyNameCreateProtectionPolicy, ProtectionMode: &protectionModeCreateProtectionPolicy, BaitProtectionStatus: &baitProtectionStatusCreateProtectionPolicy, ProtectionDirectory: &protectionDirectoryCreateProtectionPolicy, ProtectionType: &protectionTypeCreateProtectionPolicy, ExcludeDirectory: &excludeDirectoryCreateProtectionPolicy, } protectionPolicyIdProtectionInfoRequestInfo:= "" request.Body = &model.ProtectionInfoRequestInfo{ HostIdList: listHostIdListbody, AgentIdList: listAgentIdListbody, BackupProtectionStatus: "closed", CreateProtectionPolicy: createProtectionPolicybody, ProtectionPolicyId: &protectionPolicyIdProtectionInfoRequestInfo, RansomProtectionStatus: "opened", OperatingSystem: "Linux", } response, err := client.StartProtection(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
开启勒索病毒防护成功 |
错误码
请参见错误码。