查看病毒扫描任务列表
功能介绍
查看病毒扫描任务列表
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/antivirus/task
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,可通过我的凭证,项目id获取 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
参数解释: 主机所属的企业项目ID。 企业项目ID默认取值为“0”,表示默认企业项目。如果需要查询所有企业项目下的主机,请传参“all_granted_eps”。如果您只有某个企业项目的权限,则需要传递该企业项目ID,查询该企业项目下的主机,否则会因权限不足而报错。 约束限制: 开通企业项目功能后才需要配置企业项目。 取值范围: 字符长度1-256位 默认取值: 0 |
task_name |
否 |
String |
任务名称 |
offset |
是 |
Integer |
偏移量:指定返回记录的开始位置 |
limit |
是 |
Integer |
每页显示个数 |
last_days |
否 |
Integer |
查询时间范围天数,与自定义查询时间begin_time,end_time互斥 |
begin_time |
否 |
String |
自定义查询时间,与查询时间范围天数互斥,查询时间段的起始时间,毫秒级时间戳,end_time减去begin_time小于等于2天,与查询时间范围天数互斥 |
end_time |
否 |
String |
自定义时间,查询时间段的终止时间,毫秒级时间戳,end_time减去begin_time小于等于2天,与查询时间范围天数互斥 |
task_status |
否 |
String |
任务状态,包含如下4种
|
host_name |
否 |
String |
服务器名称 |
private_ip |
否 |
String |
服务器私有IP |
public_ip |
否 |
String |
服务器公网IP |
whether_paid_task |
是 |
Boolean |
此次扫描任务是否付费 |
host_task_status |
否 |
Array of strings |
服务器扫描状态,包含如下4种
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Integer |
总数 |
data_list |
Array of AntiVirusTaskResponseInfo objects |
data list |
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
任务ID |
task_name |
String |
任务名称 |
scan_type |
String |
任务类型,包含如下:
|
start_type |
String |
启动类型,包含如下:
|
action |
String |
处置动作,包含如下:
|
start_time |
Integer |
启动时间,毫秒 |
task_status |
String |
任务状态,包含如下2种
|
host_num |
Integer |
关联服务器数 |
success_host_num |
Integer |
扫描成功服务器数 |
fail_host_num |
Integer |
扫描失败服务器数 |
cancel_host_num |
Integer |
已取消服务器数 |
host_info_list |
Array of AntiVirusTaskHostResponseInfo objects |
主机信息 |
rescan |
Boolean |
是否需要重新扫描 |
whether_paid_task |
Boolean |
此次扫描任务是否付费 |
参数 |
参数类型 |
描述 |
---|---|---|
host_id |
String |
服务器ID |
host_name |
String |
服务器名称 |
private_ip |
String |
服务器私有IP |
public_ip |
String |
弹性公网IP地址 |
asset_value |
String |
资产重要性,包含如下3种
|
start_time |
Integer |
启动时间,毫秒 |
run_duration |
Integer |
运行时长,秒 |
scan_progress |
String |
扫描进度 |
virus_num |
Integer |
新发现病毒数量 |
scan_file_num |
Integer |
已扫描的文件数量 |
host_task_status |
String |
服务器扫描状态,包含如下4种
|
fail_reason |
String |
失败原因 |
deleted |
Boolean |
是否删除,包含如下:
|
whether_using_quota |
Integer |
是否使用病毒查杀按次计费配额 |
agent_id |
String |
Agent ID |
os_type |
String |
操作系统类型,包含如下2种。
|
host_status |
String |
服务器状态 |
agent_status |
String |
Agent状态,包含如下6种。
|
protect_status |
String |
防护状态,包含如下2种。
|
os_name |
String |
操作系统名称 |
os_version |
String |
操作系统版本 |
请求示例
无
响应示例
状态码:200
请求已成功
{
"total_num" : 126,
"data_list" : [ {
"task_id" : "291***af8-7ba2-4a39-9522-d1***2033db",
"task_name" : "快速查杀-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代码示例
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 |
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());
}
}
}
|
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 |
# 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)
|
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 |
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)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的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 |
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());
}
}
}
|
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 |
# 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)
|
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 |
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)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
错误码
请参见错误码。