文档

ListVirusScanTask - 查询病毒扫描的扫描任务

更新时间:

根据任务的扫描类型、扫描状态和检测的机器信息等查询符合条件的病毒扫描任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:ListVirusScanTaskRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TaskIdstring

指定要查询的病毒扫描任务 ID。

说明 您可以调用 ListVirusScanTask 接口获取该参数。
1471d8ebb96795b41ede090b9758****
ScanTypestring

指定待查询病毒扫描任务的扫描类型。 取值:

  • system:系统自动扫描
  • user:系统自定义扫描
user
Statusinteger

病毒扫描任务的执行的状态。 取值:

  • 1:检测中
  • 2:完成
  • 3:失败
  • 4:超时
1
StartTimelong

查询的任务开始时间的时间戳(毫秒)。

1680919232000
EndTimelong

查询的任务结束时间的时间戳(毫秒)。

1680919232999
RootTaskboolean

查询的任务是否是病毒扫描的主任务

true
RootTaskIdstring

根任务 ID。

说明 您可以调用 GetVirusScanLatestTaskStatistic 接口获取该参数。
89f5d7813bd59dd237580a8664b3xxxx
MachineNamestring

服务器的名称。

oracle-win-001****
InternetIpstring

公网 IP。

120.27.XX.XX
IntranetIpstring

内网 IP。

172.26.XX.XX
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
PageSizeinteger

设置分页查询时,每页包含的任务的数量。默认值为 20,表示每页包含 20 个任务。

20
StatusListarray

多个状态刷选填写的状态列表。

integer

病毒扫描任务的执行的状态。 取值:

  • 1:检测中
  • 2:完成
  • 3:失败
  • 4:超时
1
Langstring

设置请求和接收消息的语言类型,默认为 zh。 取值:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

返回的消息体。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
PageInfoobject

分页信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页最多显示的数据条数。

20
TotalCountinteger

查询到的数据总条数。

224
Listobject []

结果列表。

TaskIdstring

检查任务的 ID。

2e75557bfa570381f5c516cad9b6xxxx
ScanTypestring

病毒扫描的任务扫描类型。 取值:

  • system:系统自动扫描
  • user:用户自定义扫描
system
Statusinteger

病毒扫描任务的执行的状态。 取值:

  • 1:检测中
  • 2:完成
  • 3:失败
  • 4:超时
1
StartTimelong

开始时间戳(毫秒)。

1651290987000
EndTimelong

结束时间戳(毫秒)。

1662343860051
InstanceNamestring

服务器实例名称。

sql-test-0****
InternetIpstring

服务器的公网 IP。

8.210.XX.XX
IntranetIpstring

服务器的私网 IP。

172.25.XX.XX
TaskNamestring

任务名称。

  • VIRUS_VUL_SCHEDULE_SCAN:病毒扫描。
VIRUS_VUL_SCHEDULE_SCAN
Progressinteger

任务进度百分比。

62
ScanPatharray

扫描的文件信息。

string

文件路径。

C:/test1
Uuidstring

服务器的 UUID。

49e25e0f-bb51-4a5a-a1b3-13a4ddaa****

示例

正常返回示例

JSON格式

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 224
  },
  "List": [
    {
      "TaskId": "2e75557bfa570381f5c516cad9b6xxxx",
      "ScanType": "system",
      "Status": 1,
      "StartTime": 1651290987000,
      "EndTime": 1662343860051,
      "InstanceName": "sql-test-0****",
      "InternetIp": "8.210.XX.XX",
      "IntranetIp": "172.25.XX.XX",
      "TaskName": "VIRUS_VUL_SCHEDULE_SCAN",
      "Progress": 62,
      "ScanPath": [
        "C:/test1"
      ],
      "Uuid": "49e25e0f-bb51-4a5a-a1b3-13a4ddaa****"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈