文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 勒索防护/ 添加防护策略 - AddProtectionPolicy
更新时间:2025-12-26 GMT+08:00
分享

添加防护策略 - AddProtectionPolicy

功能介绍

添加防护策略。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

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

表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参数

参数

是否必选

参数类型

描述

policy_name

String

策略名称

protection_mode

String

防护动作,包含如下2种。

  • alarm_and_isolation :告警并自动隔离。

  • alarm_only :仅告警。

deploy_mode

String

是否开启动态诱饵,包含如下2种,默认为关闭防护动态诱饵防护。

  • opened :开启。

  • closed :关闭。

protection_directory

String

防护目录,多个目录请用英文分号隔开,最多支持填写20个防护目录

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个排除目录

operating_system

String

操作系统,包含如下:

  • Windows : Windows系统

  • Linux : Linux系统

process_whitelist

Array of TrustProcessInfo objects

进程白名单

ai_protection_status

String

参数解释:

是否开启AI勒索防护

约束限制:

不涉及

取值范围:

包含两种:

  • opened :开启。

  • closed :关闭。

默认取值:

closed

表5 TrustProcessInfo

参数

是否必选

参数类型

描述

path

String

参数解释:

进程路径

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

hash

String

参数解释:

进程hash

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

响应参数

状态码:200

请求已成功

请求示例

修改勒索病毒防护策略,目标服务器操作系统类型为Linux,防护策略ID为0253edfd-30e7-439d-8f3f-17c54c997064,防护动作为仅告警。

{
  "policy_name" : "liuzhaolingtest",
  "protection_mode" : "alarm_only",
  "deploy_mode" : "opened",
  "protection_directory" : "/root",
  "protection_type" : "txt",
  "operating_system" : "Linux"
}

响应示例

SDK代码示例

SDK代码示例如下。

 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
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.*;


public class AddProtectionPolicySolution {

    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();
        AddProtectionPolicyRequest request = new AddProtectionPolicyRequest();
        AddProtectionPolicyInfoRequestInfo body = new AddProtectionPolicyInfoRequestInfo();
        body.withOperatingSystem("Linux");
        body.withProtectionType("txt");
        body.withProtectionDirectory("/root");
        body.withDeployMode("opened");
        body.withProtectionMode("alarm_only");
        body.withPolicyName("liuzhaolingtest");
        request.withBody(body);
        try {
            AddProtectionPolicyResponse response = client.addProtectionPolicy(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());
        }
    }
}
 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
# 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 = AddProtectionPolicyRequest()
        request.body = AddProtectionPolicyInfoRequestInfo(
            operating_system="Linux",
            protection_type="txt",
            protection_directory="/root",
            deploy_mode="opened",
            protection_mode="alarm_only",
            policy_name="liuzhaolingtest"
        )
        response = client.add_protection_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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.AddProtectionPolicyRequest{}
	deployModeAddProtectionPolicyInfoRequestInfo:= "opened"
	request.Body = &model.AddProtectionPolicyInfoRequestInfo{
		OperatingSystem: "Linux",
		ProtectionType: "txt",
		ProtectionDirectory: "/root",
		DeployMode: &deployModeAddProtectionPolicyInfoRequestInfo,
		ProtectionMode: "alarm_only",
		PolicyName: "liuzhaolingtest",
	}
	response, err := client.AddProtectionPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档