跳至主内容

获取隔离项列表

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

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

服务

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

  • computers ,表示“计算机与虚拟机”

  • exchange ,表示“Exchange安全防护”

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

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

参数

参数名

类型

可选性

说明

endpointId

字符串

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

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

page

数值

结果页码,默认值为1。

perPage

数值

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

filters

对象

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

可用筛选器

您可以使用 筛选器 参数根据特定属性查询隔离项目。

查询结果是匹配所有选定筛选器的隔离项目列表。

以下是可用的筛选选项:

字段

类型

描述

threatName

字符串

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

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

startDate

字符串

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

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

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

结束日期

字符串

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

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

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

文件路径

字符串

按文件路径筛选隔离项目。

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

IP地址

字符串

按IP地址筛选隔离项目。

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

操作状态

整数

按操作状态筛选隔离项目。

可用值为 操作状态

  • 0 - 无

  • 1 - 待移除

  • 2 - 待恢复

  • 3 - 移除失败

  • 4 - 恢复失败

若服务类型为 exchange ,则以下操作状态同样有效:

  • 16 - 待保存

  • 17 - 保存失败

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

重要说明

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

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

    例如:

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

    如果 filePath*myfile.exe ,则API返回系统中所有myfile.exe文件的列表。

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

返回值

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

  • page - 当前显示的页码

  • pagesCount - 可用页面的总数

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

  • total - 项目总数

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

    • id ,隔离项的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 字段具有以下结构:

字段名称

数据类型

说明

filePath

字符串

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

对于 Exchange安全 服务, details 字段具有以下结构:

字段名称

数据类型

说明

detectionPoint

整数

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

  • 0 - 传输

  • 1 - 邮箱

  • 2 - 文件夹

  • 3 - 按需

itemType

整数

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

  • 0 - 附件

  • 1 - 邮件

threatStatus

字符串

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

  • 0 - 垃圾邮件

  • 1 - 疑似

  • 2 - 感染

  • 3 - 附件检测

  • 4 - 内容检测

  • 5 - 无法扫描

email

对象

  • senderIP ,包含发件人IP地址的字符串

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

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

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

  • realRecipients ,包含目标收件人电子邮件地址的数组

示例

请求 :

{
         "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:\\病毒0\\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:\\病毒0\\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"
                          ]
                       }
                   }
               }]
          }
     }