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

创建自定义查杀策略

功能介绍

创建自定义查杀策略

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/antivirus/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

主机所属的企业项目ID。

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

企业项目ID默认取值为“0”,表示默认企业项目。如果需要查询所有企业项目下的主机,请传参“all_granted_eps”。如果您只有某个企业项目的权限,则需要传递该企业项目ID,查询该企业项目下的主机,否则会因权限不足而报错。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

表4 请求Body参数

参数

是否必选

参数类型

描述

policy_name

String

策略名称

start_type

String

启动类型,包含如下:

  • now : 立即启动

  • later : 稍后启动

  • period : 周期启动

scan_period

String

启动类型,包含如下:

  • day :每天

  • week : 每周

  • month : 每月

scan_period_date

Integer

扫描周期日期(1-28;扫描周期为week时,1-7代表周日至周六;扫描周期为month时,1-28代表每月1日到28日)

scan_time

Integer

扫描时间戳,毫秒(仅启动类型为later时有值)

scan_hour

Integer

扫描小时数(仅启动类型为period时有值)

scan_minute

Integer

扫描分钟数(仅启动类型为period时有值)

timezone_offset

Integer

时区偏移量(仅启动类型为period时有值,单位:分钟)

file_types

Array of integers

文件类型集合型,包含如下:

  • 0 :全部

  • 1 : 可执行

  • 2 : 压缩

  • 3 : 脚本

  • 4 : 文档

  • 5 : 图片

  • 6 : 音视频

scan_dir

String

扫描目录,多个用;分隔

ignore_dir

String

排除目录,多个用;分隔

action

String

处置动作,包含如下:

  • auto :自动处置

  • manual : 人工处置

whether_paid_task

Boolean

此次扫描任务是否付费

task_id

String

任务ID

host_ids

Array of strings

策略管理主机列表

响应参数

请求示例

创建自定义查杀策略,策略名称为自定义查杀-20250416174356,扫描目录为/root,处置动作为自动处置,主机列表为09724867-7b91-482d-9702-daf9113f1b62,启动类型为立即启动,扫描任务不消耗按次计费配额。

{
  "policy_name" : "自定义查杀-20250416174356",
  "start_type" : "now",
  "file_types" : [ 1, 2, 3, 4 ],
  "scan_dir" : "/root",
  "action" : "auto",
  "whether_paid_task" : false,
  "host_ids" : [ "09724867-7b91-482d-9702-daf9113f1b62" ]
}

响应示例

SDK代码示例

SDK代码示例如下。

创建自定义查杀策略,策略名称为自定义查杀-20250416174356,扫描目录为/root,处置动作为自动处置,主机列表为09724867-7b91-482d-9702-daf9113f1b62,启动类型为立即启动,扫描任务不消耗按次计费配额。

 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
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 CreateAntiVirusPolicySolution {

    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();
        CreateAntiVirusPolicyRequest request = new CreateAntiVirusPolicyRequest();
        CreateAntiVirusPolicyRequestBody body = new CreateAntiVirusPolicyRequestBody();
        List<String> listbodyHostIds = new ArrayList<>();
        listbodyHostIds.add("09724867-7b91-482d-9702-daf9113f1b62");
        List<Integer> listbodyFileTypes = new ArrayList<>();
        listbodyFileTypes.add(1);
        listbodyFileTypes.add(2);
        listbodyFileTypes.add(3);
        listbodyFileTypes.add(4);
        body.withHostIds(listbodyHostIds);
        body.withWhetherPaidTask(false);
        body.withAction("auto");
        body.withScanDir("/root");
        body.withFileTypes(listbodyFileTypes);
        body.withStartType("now");
        body.withPolicyName("自定义查杀-20250416174356");
        request.withBody(body);
        try {
            CreateAntiVirusPolicyResponse response = client.createAntiVirusPolicy(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());
        }
    }
}

创建自定义查杀策略,策略名称为自定义查杀-20250416174356,扫描目录为/root,处置动作为自动处置,主机列表为09724867-7b91-482d-9702-daf9113f1b62,启动类型为立即启动,扫描任务不消耗按次计费配额。

 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
# 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 = CreateAntiVirusPolicyRequest()
        listHostIdsbody = [
            "09724867-7b91-482d-9702-daf9113f1b62"
        ]
        listFileTypesbody = [
            1,
            2,
            3,
            4
        ]
        request.body = CreateAntiVirusPolicyRequestBody(
            host_ids=listHostIdsbody,
            whether_paid_task=False,
            action="auto",
            scan_dir="/root",
            file_types=listFileTypesbody,
            start_type="now",
            policy_name="自定义查杀-20250416174356"
        )
        response = client.create_anti_virus_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)

创建自定义查杀策略,策略名称为自定义查杀-20250416174356,扫描目录为/root,处置动作为自动处置,主机列表为09724867-7b91-482d-9702-daf9113f1b62,启动类型为立即启动,扫描任务不消耗按次计费配额。

 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
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.CreateAntiVirusPolicyRequest{}
	var listHostIdsbody = []string{
        "09724867-7b91-482d-9702-daf9113f1b62",
    }
	var listFileTypesbody = []int32{
        int32(1),
	    int32(2),
	    int32(3),
	    int32(4),
    }
	scanDirCreateAntiVirusPolicyRequestBody:= "/root"
	request.Body = &model.CreateAntiVirusPolicyRequestBody{
		HostIds: listHostIdsbody,
		WhetherPaidTask: false,
		Action: "auto",
		ScanDir: &scanDirCreateAntiVirusPolicyRequestBody,
		FileTypes: listFileTypesbody,
		StartType: "now",
		PolicyName: "自定义查杀-20250416174356",
	}
	response, err := client.CreateAntiVirusPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档

    提示

    您即将访问非华为云网站,请注意账号财产安全