文档

DescribeScanTaskProgress - 查询病毒扫描任务进度

更新时间:

查询病毒扫描任务进度。

调试

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

授权信息

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

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

请求参数

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

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

说明 您可以调用 StartVirusScanTask 接口获取该参数。
282832

返回参数

名称类型描述示例值
object
TargetInfostring

病毒扫描任务扫描的资产信息。该参数使用 JSON 数组转化的字符串格式表示。包含以下字段:

  • type:执行病毒扫描的资产类型。取值:
    • groupId:服务器分组。
    • uuid:服务器。
  • name:服务器分组名称或服务器的名称。
  • target:执行病毒扫描的资产。以下是该字段的取值说明:
    • type 的值为 groupId 时,该字段为服务器分组 ID。
    • type 的值为 uuid 时,该字段为服务器的 UUID。
[{"type":"uuid","name":"host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]
RequestIdstring

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

EA15BA8A-D631-4375-8D40-CB7C769B0279
ScanTaskProgressstring

病毒扫描任务的进度。取值:

  • init:扫描任务初始化中。
  • Processing:扫描任务进行中。
  • Success:扫描任务已完成。
  • Failed:扫描任务执行失败。
Success

示例

正常返回示例

JSON格式

{
  "TargetInfo": "[{\"type\":\"uuid\",\"name\":\"host001\",\"target\":\"503201a7-14c6-4280-801b-1169ed42****\"}]",
  "RequestId": "EA15BA8A-D631-4375-8D40-CB7C769B0279",
  "ScanTaskProgress": "Success"
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈