跳至主内容

createScanTask

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

参数

参数

类型

可选

描述

targetIds

数组

否

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

类型

数字

否

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

名称

字符串

是

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

自定义扫描设置

数组

否

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

返回任务ID （已弃用）

布尔值

是

警告

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

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

  • true ，若请求成功，将返回最新创建任务的ID。

  • false ，将不返回最新任务的ID，而是返回一个布尔值。

默认值： false .

注意

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

returnAllTaskIds

布尔型

是

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

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

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

默认值： false .

返回值

此方法返回新创建任务的ID或一个布尔值，该值为 真 表示任务创建成功。

示例

请求 : 

{
    "params": {
        "targetIds": [
            "63f491e5aeb92d393da4ee27", "642ed114edc94a4d0ea7be98"
        ],
        "type": 4,
        "name": "我的扫描",
        "customScanSettings": {
            "scanDepth": 1,
            "scanPath": [
                "本地驱动器"
            ]
        },
        "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"
    ]
}
本节内容 :