文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 病毒查杀/ 查看病毒扫描任务列表 - ListAntiVirusTask
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

查看病毒扫描任务列表 - ListAntiVirusTask

功能介绍

查看病毒扫描任务列表

授权信息

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

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

URI

GET /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）。

task_name

否

String

任务名称

offset

是

Integer

参数解释:

偏移量：指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0，最大值2000000

默认取值:

不涉及

limit

是

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

last_days

否

Integer

查询时间范围天数，与自定义查询时间begin_time，end_time互斥

begin_time

否

String

自定义查询时间，开始时间

end_time

否

String

自定义查询时间，结束时间

task_status

否

String

任务状态，包含如下4种

  • scanning ：扫描中

  • cancel ：已取消

  • fail ：扫描失败

  • finish ：已完成

host_name

否

String

参数解释:

服务器名称

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

private_ip

否

String

参数解释:

服务器私有IP

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

public_ip

否

String

服务器公网IP

whether_paid_task

是

Boolean

此次扫描任务是否付费

host_task_status

否

Array of strings

服务器扫描状态，包含如下4种

  • scanning ：扫描中

  • success ：扫描成功

  • fail ：扫描失败

  • cancel ：取消扫描

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

总数

取值范围:

最小值0，最大值2147483647

data_list

Array of AntiVirusTaskResponseInfo objects

data list
表5 AntiVirusTaskResponseInfo

参数

参数类型

描述

task_id

String

任务ID

task_name

String

任务名称

scan_type

String

任务类型，包含如下:

  • quick ：快速扫描

  • full : 全盘扫描

  • custom : 自定义扫描

start_type

String

启动类型，包含如下:

  • now : 立即启动

  • later : 稍后启动

  • period : 周期启动

action

String

处置动作，包含如下:

  • auto：自动处置

  • manual：人工处置

start_time

Integer

启动时间，毫秒

task_status

String

任务状态，包含如下2种

  • scanning ：扫描中

  • finish ：扫描完成

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

此次扫描任务是否付费
表6 AntiVirusTaskHostResponseInfo

参数

参数类型

描述

host_id

String

参数解释：

主机ID

取值范围：

字符长度1-64位

host_name

String

参数解释:

服务器名称

取值范围:

字符长度1-256位

private_ip

String

参数解释：

服务器私有IP

取值范围：

字符长度1-128位

public_ip

String

参数解释：

弹性公网IP地址

取值范围：

字符长度1-256位

asset_value

String

资产重要性，包含如下3种

  • important ：重要资产

  • common ：一般资产

  • test ：测试资产

start_time

Integer

启动时间，毫秒

run_duration

Integer

运行时长，秒

scan_progress

String

扫描进度

virus_num

Integer

新发现病毒数量

scan_file_num

Integer

已扫描的文件数量

host_task_status

String

服务器扫描状态，包含如下4种

  • scanning ：扫描中

  • success ：扫描成功

  • fail ：扫描失败

  • cancel ：取消扫描

fail_reason

String

失败原因

deleted

Boolean

是否删除，包含如下:

  • true ：已删除

  • false : 未删除

whether_using_quota

Integer

是否使用病毒查杀按次计费配额

agent_id

String

参数解释:

Agent ID

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

os_type

String

参数解释：

操作系统类型

取值范围：

  • Linux：Linux。

  • Windows：Windows。

host_status

String

参数解释：

主机状态

取值范围:

  • ACTIVE：正在运行。

  • SHUTOFF：关机。

  • BUILDING：创建中。

  • ERROR：故障。

agent_status

String

参数解释：

Agent状态

取值范围:

  • installed：已安装。

  • not_installed：未安装。

  • online：在线。

  • offline：离线。

  • install_failed：安装失败。

  • installing：安装中。

  • not_online：不在线的（除了在线以外的所有状态，仅作为查询条件）。

protect_status

String

防护状态，包含如下2种。

  • closed ：关闭。

  • opened ：开启。

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
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 病毒查杀

相关文档