跳至主内容

获取隔离项列表

此方法用于检索公司可用的隔离项目列表。

项目可以是文件或Microsoft Exchange对象。

服务

此方法要求您将 {服务} 名称置于API URL中。允许的服务包括:

  • computers(计算机) ,对应"计算机与虚拟机"

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

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

https://您的域名/api/v1.0/jsonrpc/quarantine/exchange

参数

参数

类型

可选

描述

endpointId

字符串

需要获取隔离项的目标计算机ID。

若请求中未包含此参数,则返回全网所有隔离项。

page

数字

结果页码,默认值为1。

perPage

数字

每页显示条目数,上限为100条/页,默认值为30条/页。

filters

对象

查询隔离项列表时使用的筛选器。关于可用筛选器及其使用方法,请参阅 可用筛选器 .

可用筛选器

可通过 filters 参数按特定属性查询隔离项。

查询结果为匹配所有选定筛选条件的隔离项列表。

可用筛选选项如下:

字段

类型

描述

threatName

字符串

按威胁名称筛选隔离项目。

此筛选器适用于 计算机Exchange 服务。

startDate

字符串

筛选指定日期之后被隔离的项目。

日期格式为 startDate 采用ISO 8601标准。

此筛选器适用于 计算机Exchange 服务。

endDate

字符串

筛选指定日期之前被隔离的项目。

日期格式为 endDate 采用ISO 8601标准。

此筛选器适用于 计算机Exchange 服务。

filePath

字符串

按文件路径筛选隔离项。

此筛选器适用于 计算机 服务。

ip

字符串

按IP地址筛选隔离项。

此筛选器适用于 计算机 服务。

actionStatus

整数

按操作状态筛选隔离项。

可用的 actionStatus 值为:

  • 0 - 无

  • 1 - 待移除

  • 2 - 待恢复

  • 3 - 移除失败

  • 4 - 恢复失败

若服务为 交换 ,则以下操作状态也将有效:

  • 16 - 保存待定

  • 17 - 保存失败

此筛选器适用于 计算机交换 服务。

重要说明

  • 字段 threatName , filePathip 支持部分匹配。

    筛选器将返回完全匹配或以指定值开头的项。若要将指定值作为后缀使用,请使用星号符号(*)。

    例如:

    filePathC:\temp ,则API将返回源自此文件夹的所有项(包括子文件夹)。

    filePath*myfile.exe ,则该API会返回系统中所有名为myfile.exe的文件列表。

  • Exchange 筛选器需要有效的许可证密钥。

返回值

此方法返回一个包含隔离项对象的数组。数组中的每个条目具有以下结构:

  • page - 当前显示的页码

  • pagesCount - 可用页面的总数

  • perPage - 每页返回的条目总数

  • total - 条目总数

  • items - 隔离项列表。列表中的每个条目包含以下字段:

    • id ,隔离项的唯一标识符;

    • quarantinedOn ,对象被隔离的日期和时间;

    • actionStatus ,对隔离文件采取操作的状态:( 0 - 无操作; 1 - 待删除; 2 - 待恢复; 3 - 删除失败; 4 - 恢复失败; 16 - 等待保存; 17 - 保存失败) ,

    • endpointId ,检测到威胁的终端ID,

    • endpointName ,检测到威胁的终端名称,

    • endpointIP ,检测到威胁的终端IP,

    • canBeRestored ,其值为 True 表示允许执行恢复操作, False 则表示不允许,

    • companyId ,公司ID,

    • details ,与隔离项相关的更多信息。有关details成员内容的具体说明,请参阅“details内容” details内容 .

details内容

对于 计算机与虚拟机 服务, details 字段的结构如下:

字段名称

数据类型

描述

文件路径

字符串

在被检测端点上受感染或可疑文件的路径

对于 Exchange安全服务 服务, 详细信息 字段具有以下结构:

字段名称

数据类型

描述

检测点

整数

检测发生的层级。可能取值:

  • 0 - 传输层

  • 1 - 邮箱

  • 2 - 文件夹

  • 3 - 按需扫描

项目类型

整数

被隔离对象类型。可能取值:

  • 0 - 附件

  • 1 - 邮件

threatStatus

字符串

扫描完成后对象的状态。该状态显示邮件是否为垃圾邮件或包含不良内容,或附件是否感染恶意软件、疑似感染、不受欢迎或无法扫描。可能取值为:

  • 0 - 垃圾邮件

  • 1 - 疑似

  • 2 - 已感染

  • 3 - 附件检测

  • 4 - 内容检测

  • 5 - 无法扫描

email

对象

  • senderIP ,包含发送者IP地址的字符串

  • senderEmail ,由发送者电子邮件地址组成的字符串,显示在邮件头中 fieldFrom

  • subject ,包含被隔离邮件主题的字符串

  • recipients ,包含收件人的数组,显示在邮件头字段中 收件人 抄送

  • 实际收件人 ,一个包含目标收件人邮箱地址的数组

示例

请求 :

{
         "params": {
             
             "endpointId": "5d36c255f23f730fa91944e2",
             "page": 2,
             "perPage": 1,
             "filters": {
                 "threatName": "病毒0",
                 "actionStatus": 1,
                 "startDate": "2019-07-28T11:31:28",
                 "endDate": "2019-08-16T11:31:16",
                 "filePath": "c:\\Virus0\\virus0.exe"
             }
         },
         "jsonrpc": "2.0",
         "method": "getQuarantineItemsList",
         "id": "5399c9b5-0b46-45e4-81aa-889952433d86"
     }

响应 :

此响应示例适用于计算机服务:
     {
         "id": "5399c9b5-0b46-45e4-81aa-889952433d86",
         "jsonrpc": "2.0",
         "result": {
             "total": 2,
             "page": 2,
             "perPage": 1,
             "pagesCount": 2,
             "items": [
                 {
                     "id": "5d3968e0f23f730ecb0f68c2",
                     "quarantinedOn": "2019-07-28T11:31:28",
                     "actionStatus": 1,
                     "companyId": "55896b87b7894d0f367b23c6",
                     "endpointId": "5d36c255f23f730fa91944e2",
                     "endpointName": "计算机1",
                     "endpointIP": "156.133.37.181",
                     "canBeRestored": false,
                     "canBeRemoved": false,
                     "threatName": "病毒0",
                     "details": {
                         "filePath": "c:\\Virus0\\virus0.exe"
                     }
                 }
             ]
         }
     }  
此响应示例适用于Exchange服务:
     {
         "id":"5399c9b5-0b46-45e4-81aa-889952433d86",
         "jsonrpc":"2.0",
         "result": {
              page: 2,
              pagesCount: 10,
              perPage: 1,
              total: 10
              items[{
                   "id": "5b7d219bb1a43d170b7b23ee",
                   "quarantinedOn": "2019-08-01T07:15:20",
                   "actionStatus": 1,
                   "endpointId": "5d36c255f23f730fa91944e2",
                   "endpointName": "计算机1",
                   "endpointIP": "57.238.160.118",
                   "endpointAvailable": true,
                   "threatName": "病毒0",
                   "companyId": "55896b87b7894d0f367b23c6",
                   "details": {
                       "threatStatus": 4,
                       "itemType" : 0,
                       "detectionPoint": 1,
                       "email": { 
                           "senderIP": "185.36.136.238",
                           "senderEmail": "test@test.com",
                           "subject":
                         "测试主题_5b7d2128b1a43da20c7b23c6",
                           "recipients": [
                              "receiver1@test.com", "
                              receiver2@test.com",
                           ]
                           "realRecipients": [
                              "receiver1@test.com", "
                              receiver2@test.com"
                          ]
                       }
                   }
               }]
          }
     }