Viewing the Virus Scan Task List

Function

This API is used to view the virus scan task list.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/antivirus/task

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
task_name	No	String	Task name
offset	Yes	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value N/A
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10
last_days	No	Integer	Number of days to be queried. This parameter is mutually exclusive with begin_time and end_time.
begin_time	No	String	Customized start time of a segment. The timestamp is accurate to milliseconds. The end_time should be no more than two days earlier than the begin_time. This parameter is mutually exclusive with the queried duration.
end_time	No	String	Customized end time of a query time range. The timestamp is accurate to milliseconds. The end_time should be no more than two days earlier than the begin_time. This parameter is mutually exclusive with the queried duration.
task_status	No	String	Task status. The options are as follows: scanning cancel fail finish
host_name	No	String	Definition Server name. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A
private_ip	No	String	Definition Server private IP address. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
public_ip	No	String	Server public IP address
whether_paid_task	Yes	Boolean	Whether the scan task is paid.
host_task_status	No	Array of strings	Server scan status. The options are as follows: scanning success fail cancel: Cancel the scan.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.
data_list	Array of AntiVirusTaskResponseInfo objects	data list

**Table 5** AntiVirusTaskResponseInfo
Parameter	Type	Description
task_id	String	Task ID
task_name	String	Task name
scan_type	String	Service type. Its value can be: quick: quick scan full: full scan custom: custom scan.
start_type	String	Start type. Its value can be: now later period
action	String	Handling mode. It can be: auto: automatic handling manual: manual handling
start_time	Integer	Start time, in milliseconds.
task_status	String	Task status. The options are as follows: scanning finish
host_num	Integer	Associated servers
success_host_num	Integer	Number of servers successfully scanned
fail_host_num	Integer	Servers failed to be scanned
cancel_host_num	Integer	Canceled servers
host_info_list	Array of AntiVirusTaskHostResponseInfo objects	Server information
rescan	Boolean	Whether to rescan
whether_paid_task	Boolean	Whether the scan task is paid.

**Table 6** AntiVirusTaskHostResponseInfo
Parameter	Type	Description
host_id	String	Definition Host ID. Range Length: 1 to 64 characters
host_name	String	Definition Server name. Range The value can contain 1 to 256 characters.
private_ip	String	Definition Server private IP address. Range The value can contain 1 to 128 characters.
public_ip	String	Definition EIP. Range The value can contain 1 to 256 characters.
asset_value	String	Asset importance. Its value can be: important common test
start_time	Integer	Start time, in milliseconds.
run_duration	Integer	Duration (s).
scan_progress	String	Scan progress
virus_num	Integer	Detected viruses
scan_file_num	Integer	Scanned files
host_task_status	String	Server scan status. The options are as follows: scanning fail cancel: Cancel the scan. -success
fail_reason	String	Failure cause
deleted	Boolean	Delete or not. The options are as follows: true: deleted false: not deleted
whether_using_quota	Integer	Whether to use the times-based charging quota for virus scan
agent_id	String	Definition Agent ID Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
os_type	String	Definition OS type. Range Linux Windows
host_status	String	Server status
agent_status	String	Agent status. It can be: installed not_installed online offline install_failed installing not_online: All status except online. This value is used only as a query condition.
protect_status	String	Protection status. It can be: closed opened
os_name	String	OS name
os_version	String	OS Version

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 126,
  "data_list" : [ {
    "task_id" : "291***af8-7ba2-4a39-9522-d1***2033db",
    "task_name" : "Quick Scan-20250122155127",
    "scan_type" : "quick",
    "start_type" : "now",
    "action" : "manual",
    "start_time" : 1737532317458,
    "task_status" : "scanning",
    "host_num" : 1,
    "success_host_num" : 0,
    "fail_host_num" : 0,
    "cancel_host_num" : 0,
    "host_info_list" : [ {
      "host_id" : "eedf8817-f486-4c4f-a395-b8373ecc7ef4",
      "host_name" : "agentcompile-2",
      "agent_id" : "5dd59023ad***02f9f43743dff3b8172**271ad36e5aedecf327119",
      "private_ip" : "172.16.0.**",
      "public_ip" : "100.85.219.**",
      "asset_value" : "common",
      "start_time" : 1737532317458,
      "run_duration" : 0,
      "scan_progress" : "0%",
      "virus_num" : 4,
      "scan_file_num" : 0,
      "host_task_status" : "scanning",
      "os_type" : "Linux",
      "host_status" : "ACTIVE",
      "agent_status" : "online",
      "protect_status" : "opened",
      "os_name" : "EulerOS",
      "os_version" : "2.5",
      "deleted" : false,
      "whether_using_quota" : 0
    } ],
    "rescan" : false,
    "whether_paid_task" : false
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

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

    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();
        ListAntiVirusTaskRequest request = new ListAntiVirusTaskRequest();
        try {
            ListAntiVirusTaskResponse response = client.listAntiVirusTask(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = ListAntiVirusTaskRequest()
        response = client.list_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)

          

        

      
     

      
       
         
         
           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.ListAntiVirusTaskRequest{}
	response, err := client.ListAntiVirusTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     