更新时间:2025-08-15 GMT+08:00
分享

开启勒索病毒防护

功能介绍

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

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/ransomware/protection/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位

默认取值:

不涉及

region

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

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

默认取值:

不涉及

表5 ProtectionProxyInfoRequestInfo

参数

是否必选

参数类型

描述

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

参数解释:

防护文件类型,例如:docx,txt,avi,新建防护策略则必填

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

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

进程白名单

表6 TrustProcessInfo

参数

是否必选

参数类型

描述

path

String

参数解释:

进程路径

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

hash

String

参数解释:

进程hash

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

表7 BackupResources

参数

是否必选

参数类型

描述

vault_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度0-64

默认取值:

不涉及

resource_list

Array of ResourceInfo objects

参数解释:

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

约束限制:

不涉及

取值范围:

取值0-20条主机id

默认取值:

不涉及

表8 ResourceInfo

参数

是否必选

参数类型

描述

host_id

String

参数解释:

主机id

约束限制:

不涉及

取值范围:

字符长度0-128

默认取值:

不涉及

history_backup_status

String

参数解释:

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

约束限制:

不涉及

取值范围:

  • closed:关闭备份

  • opened:开启备份

默认取值:

不涉及

表9 UpdateBackupPolicyRequestInfo1

参数

是否必选

参数类型

描述

enabled

Boolean

参数解释:

策略是否启用

约束限制:

不涉及

取值范围:

  • true:策略已启用

  • false:策略未启用

默认取值:

true

policy_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256

默认取值:

不涉及

operation_definition

OperationDefinitionRequestInfo object

参数解释:

调度参数

约束限制:

不涉及

取值范围:

取值为0到100。

默认取值:

不涉及

trigger

BackupTriggerRequestInfo1 object

参数解释:

策略时间调度规则。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表10 OperationDefinitionRequestInfo

参数

是否必选

参数类型

描述

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。

默认取值:

不涉及

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

响应示例

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
69
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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        StartProtectionRequest request = new StartProtectionRequest();
        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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = StartProtectionRequest()
        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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.StartProtectionRequest{}
	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

请求已成功

错误码

请参见错误码

相关文档