ListVulScanTasks - 批量查询漏洞扫描任务

更新时间:
复制 MD 格式

分页查询当前阿里云账号下的漏洞扫描任务。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

CurrentPage

integer

分页查询时显示的当前页的页码。取值:1~10000。

1

PageSize

integer

分页查询时设置的每页数量。取值:1~1000。

10

TaskName

string

任务名称,支持模糊查询。长度不超过 128 个字符。

研发部门漏洞扫描

TaskIds

array

按漏洞扫描任务 ID 过滤,最多包含 100 个,不允许重复。

string

漏洞扫描任务 ID。取值来源:

vul-scan-task-4d7b1e9a6c38****

TaskType

string

按任务类型过滤。取值:

  • Instant:即时任务,由 CreateVulScanTask 创建。

  • Scheduled:定时任务,由漏洞定时扫描策略按周期自动创建。

枚举值:

  • Scheduled :

    定时任务

  • Instant :

    即时任务

Instant

MatchMode

string

按生效范围的匹配方式过滤。取值:

  • UserGroupAll:对当前阿里云账号下的全部用户生效。

  • UserGroupNormal:仅对指定用户组内的用户生效。

枚举值:

  • UserGroupNormal :

    部分用户组生效

  • UserGroupAll :

    全员生效

UserGroupNormal

Status

string

按任务状态过滤。取值:

  • Running:进行中,任务仍在有效期内。

  • Expired:已失效,任务已超出有效期。

  • Canceled:已取消。

枚举值:

  • Running :

    进行中

  • Expired :

    已失效

  • Canceled :

    已取消

Running

ScheduledStrategyId

string

漏洞定时扫描策略 ID,用于筛选由该策略触发的任务。取值来源:

vul-scan-scheduled-strategy-8a3f6c2e91b7****

UserGroupId

string

用户组 ID,用于筛选生效范围包含该用户组的记录。取值来源:

usergroup-9d4f2a7b3c1e****

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

本次请求的 ID。

3D7EC0AF-DB2A-5D9C-90EC-F090A6BAAEA7

TotalNum

integer

符合查询条件的漏洞扫描任务总数。

37

Tasks

array<object>

漏洞扫描任务列表。

array<object>

漏洞扫描任务。

TaskId

string

漏洞扫描任务 ID。

vul-scan-task-4d7b1e9a6c38****

TaskName

string

任务名称。

研发部门漏洞扫描

TaskDescription

string

任务描述。未填写时返回空字符串。

对研发部门终端执行一次漏洞扫描

TaskType

string

任务类型。取值:

  • Instant:即时任务,由 CreateVulScanTask 创建。

  • Scheduled:定时任务,由漏洞定时扫描策略按周期自动创建。

枚举值:

  • Scheduled :

    定时任务

  • Instant :

    即时任务

Instant

ScheduledStrategyId

string

触发该任务的漏洞定时扫描策略 ID。TaskType 取值为 Instant 时返回空字符串。

vul-scan-scheduled-strategy-8a3f6c2e91b7****

MatchMode

string

生效范围的匹配方式。取值:

  • UserGroupAll:对当前阿里云账号下的全部用户生效。

  • UserGroupNormal:仅对指定用户组内的用户生效。

枚举值:

  • UserGroupNormal :

    部分用户组生效

  • UserGroupAll :

    全员生效

UserGroupNormal

Whitelist

array

例外用户名单,名单内的用户不执行本次扫描。未配置时返回空列表。

string

用户名。

王先生

EndTimestamp

integer

任务失效时间,秒级 Unix 时间戳。到达该时间后终端不再拉取执行本任务。

1786291200

CreateTime

integer

任务创建时间,秒级 Unix 时间戳。

1786291200

Status

string

任务状态。取值:

  • Running:进行中,任务仍在有效期内。

  • Expired:已失效,任务已超出有效期。

  • Canceled:已取消。

枚举值:

  • Running :

    进行中

  • Expired :

    已失效

  • Canceled :

    已取消

Running

CustomMatchGroup

array<object>

按组织架构指定的生效范围。未按组织架构配置时返回空列表。

object

组织架构生效范围。

IdpId

string

身份源 ID。

idp-7c3f9a2e5b18****

Group

array

组织架构节点集合。

string

组织架构节点的 DN。

OU=研发部,OU=SASE

TargetDeviceCount

object

本任务在生效范围内各用户终端设备上的执行情况统计。

AckCount

integer

已确认接收本任务的用户终端设备数。

12

StartCount

integer

正在执行扫描的用户终端设备数,由 AckCount 减去 SuccessCount 与 FailCount 得到。

3

SuccessCount

integer

扫描成功的用户终端设备数。

8

FailCount

integer

扫描失败的用户终端设备数。

1

VulCount

integer

本任务累计检出的漏洞数。

27

MatchTargetIds

array

生效的用户组 ID 集合。MatchMode 取值为 UserGroupAll 时返回空列表。

string

用户组 ID。

usergroup-9d4f2a7b3c1e****

示例

正常返回示例

JSON格式

{
  "RequestId": "3D7EC0AF-DB2A-5D9C-90EC-F090A6BAAEA7",
  "TotalNum": 37,
  "Tasks": [
    {
      "TaskId": "vul-scan-task-4d7b1e9a6c38****",
      "TaskName": "研发部门漏洞扫描",
      "TaskDescription": "对研发部门终端执行一次漏洞扫描",
      "TaskType": "Instant",
      "ScheduledStrategyId": "vul-scan-scheduled-strategy-8a3f6c2e91b7****",
      "MatchMode": "UserGroupNormal",
      "Whitelist": [
        "王先生"
      ],
      "EndTimestamp": 1786291200,
      "CreateTime": 1786291200,
      "Status": "Running",
      "CustomMatchGroup": [
        {
          "IdpId": "idp-7c3f9a2e5b18****",
          "Group": [
            "OU=研发部,OU=SASE"
          ]
        }
      ],
      "TargetDeviceCount": {
        "AckCount": 12,
        "StartCount": 3,
        "SuccessCount": 8,
        "FailCount": 1
      },
      "VulCount": 27,
      "MatchTargetIds": [
        "usergroup-9d4f2a7b3c1e****"
      ]
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情