跳至主内容

createAddFileToQuarantineTask

该方法用于创建将文件添加到隔离区的新任务。

重要提示

本文主要部分包含该方法1.1版本的信息。1.0版本信息可查阅 此处 .

服务

调用此方法需在API URL中指定 {service} 名称。允许的服务包括:

  • exchange (对应"Exchange安全防护")

  • computers ,对应“计算机与虚拟机”服务

例如, computers 服务的请求URL为:

https://YOUR-HOSTNAME/api/v1.0/jsonrpc/quarantine/computers

参数

参数

类型

可选性

描述

endpointIds

数组

目标端点ID列表。单次最多指定100个目标。仅检测与防护模式下安装安全代理且EDR传感器模块处于活动状态的端点可作为有效目标。

filePath

字符串

磁盘上的绝对文件路径。该路径长度不得超过4096字符,且需符合目标端点操作系统的格式要求。

返回值

该方法返回一个包含所创建任务父任务ID的数组。

示例

请求 :

{
       "params": {
           "endpointIds": [
               "63896b87b7894d0f367b23c6",
               "65896b87b7894d0f367b23c6"
           ],
           "filePath": "Z:\\path\\to\\file"
       },
       "jsonrpc": "2.0",
       "method": "createAddFileToQuarantineTask",
       "id": "5399c9b5-0b46-45e4-81aa-889952433d86"
  }

响应 :

{
      "id": "5399c9b5-0b46-45e4-81aa-889952433d86",
      "jsonrpc":"2.0",
      "result": [
          "652feab6b9684f3ba80685d5",
          "652feab6b9684f3ba80685d5"
      ]
}

版本1.0

参数

参数

类型

可选

描述

endpointIds

数组

目标端点ID列表。单次最多可指定100个目标。仅处于检测与防护模式且EDR传感器模块处于活动状态的带安全代理的端点可作为有效目标。

filePath

字符串

磁盘上的绝对文件路径。该路径长度最多为4096个字符,且应符合目标端点操作系统的格式要求。

返回值

本方法返回布尔值,任务创建成功时返回True。

示例

请求 :

{
       "params": {
           "endpointIds": [
               "63896b87b7894d0f367b23c6",
               "65896b87b7894d0f367b23c6"
           ],
           "filePath": "Z:\\path\\to\\file"
       },
       "jsonrpc": "2.0",
       "method": "createAddFileToQuarantineTask",
       "id": "5399c9b5-0b46-45e4-81aa-889952433d86"
  }

响应 :

{
      "id": "5399c9b5-0b46-45e4-81aa-889952433d86",
      "jsonrpc":"2.0",
      "result": true
  }