跳至主内容

createScanTask

此方法用于创建新的扫描任务。

注意

请注意，来自 虚拟机 服务的受控终端也会显示在 计算机 服务的 自定义分组 中。为避免启动重复扫描任务，建议您使用 计算机 服务中的终端。

服务

此方法要求您在API URL中填入 {service} 名称。允许的服务包括：

  • 计算机 ，适用于“计算机和虚拟机”

  • virtualmachines ，适用于“虚拟机”

例如， 虚拟机 服务的请求URL为：

https://YOUR-HOSTNAME/api/v1.0/jsonrpc/network/virtualmachines

参数

参数

类型

可选性

描述

targetIds

数组

否

包含待扫描目标ID的列表。目标ID可指定为终端或容器。

type

数值

否

扫描类型。可选值为：1 - 快速扫描；2 - 全盘扫描；3 - 内存扫描；4 - 自定义扫描

name

字符串

是

任务名称。若未传递该参数，名称将自动生成。

customScanSettings

数组

否

包含扫描深度和扫描路径等信息的对象。该对象仅应在 type 参数值为 4 - 自定义扫描。若为其他类型设置此参数，相关值将被忽略。参数 $customScanSettings 必须包含以下属性：int $scanDepth 扫描深度配置。可选值： 1 - 激进模式； 2 - 常规模式； 3 - 宽松模式array $scanPath 待扫描目标路径列表

returnTaskId (已弃用)

布尔型

是

警告

建议改用 returnAllTaskIds 参数，以确保响应中返回请求生成的所有任务ID。

指示请求是否返回最新创建的任务ID。可选值：

  • true ，请求成功时将返回最新任务ID。

  • false ，不返回最新任务ID，仅返回布尔值。

默认值： false .

注意

若同时设置 returnTaskId 与 returnAllTaskIds 为 true 时，仅返回由 returnAllTaskIds 参数请求的信息。

returnAllTaskIds

布尔型

是

表示响应是否包含因请求而创建的所有任务的ID。可选值：

  • true - 将返回一个字符串数组，包含因请求而创建的所有任务的ID。

  • false - 不返回任何任务ID。

默认值： false .

返回值

此方法返回新创建任务的ID，若任务创建成功则返回布尔值 true 。

示例

请求 : 

{
    "params": {
        "targetIds": [
            "63f491e5aeb92d393da4ee27", "642ed114edc94a4d0ea7be98"
        ],
        "type": 4,
        "name": "我的扫描",
        "customScanSettings": {
            "扫描深度": 1,
            "扫描路径": [
                "本地驱动器"
            ]
        },
        "returnAllTaskIds":true
    },
    "jsonrpc": "2.0",
    "method": "createScanTask",
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
}

响应 : 

{
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "jsonrpc": "2.0",
    "result": [
        "64356e4590cbea5a7600ca1e",
        "64356e4590cbea5a7600ca21"
    ]
}
本节内容 :