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

创建病毒扫描任务

功能介绍

创建病毒扫描任务

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/antivirus/task

表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

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

task_name

String

任务名称

task_id

String

任务ID 创建病毒扫描任务时,task_id是null.重新扫描时,task_id不是null,是当前任务的ID

scan_type

String

任务类型,包含如下:

  • quick :快速扫描

  • full : 全盘扫描

  • custom : 自定义扫描

action

String

处置动作,包含如下:

  • auto:自动处置

  • manual:人工处置

host_ids

Array of strings

策略管理主机列表

响应参数

状态码:200

请求已成功

请求示例

编辑任务名称为任务的病毒扫描任务,任务类型为快速扫描,处置动作为人工处置,主机列表为eab583a8-ff16-4b7a-aefc-e95ad3a78388

{
  "task_name" : "任务",
  "scan_type" : "quick",
  "action" : "manual",
  "host_ids" : [ "eab583a8-ff16-4b7a-aefc-e95ad3a78388" ]
}

响应示例

SDK代码示例

SDK代码示例如下。

编辑任务名称为任务的病毒扫描任务,任务类型为快速扫描,处置动作为人工处置,主机列表为eab583a8-ff16-4b7a-aefc-e95ad3a78388

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

    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();
        CreateAntiVirusTaskRequest request = new CreateAntiVirusTaskRequest();
        CreateAntiVirusTaskRequestInfo body = new CreateAntiVirusTaskRequestInfo();
        List<String> listbodyHostIds = new ArrayList<>();
        listbodyHostIds.add("eab583a8-ff16-4b7a-aefc-e95ad3a78388");
        body.withHostIds(listbodyHostIds);
        body.withAction("manual");
        body.withScanType("quick");
        body.withTaskName("任务");
        request.withBody(body);
        try {
            CreateAntiVirusTaskResponse response = client.createAntiVirusTask(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());
        }
    }
}

编辑任务名称为任务的病毒扫描任务,任务类型为快速扫描,处置动作为人工处置,主机列表为eab583a8-ff16-4b7a-aefc-e95ad3a78388

 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
# 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 = CreateAntiVirusTaskRequest()
        listHostIdsbody = [
            "eab583a8-ff16-4b7a-aefc-e95ad3a78388"
        ]
        request.body = CreateAntiVirusTaskRequestInfo(
            host_ids=listHostIdsbody,
            action="manual",
            scan_type="quick",
            task_name="任务"
        )
        response = client.create_anti_virus_task(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

编辑任务名称为任务的病毒扫描任务,任务类型为快速扫描,处置动作为人工处置,主机列表为eab583a8-ff16-4b7a-aefc-e95ad3a78388

 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.CreateAntiVirusTaskRequest{}
	var listHostIdsbody = []string{
        "eab583a8-ff16-4b7a-aefc-e95ad3a78388",
    }
	request.Body = &model.CreateAntiVirusTaskRequestInfo{
		HostIds: listHostIdsbody,
		Action: "manual",
		ScanType: "quick",
		TaskName: "任务",
	}
	response, err := client.CreateAntiVirusTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档