获取隔离项列表
此方法用于获取公司可用的隔离项列表。
隔离项可以是文件或Microsoft Exchange对象。
服务
此方法要求您将
{服务}
名称置于API URL中。允许的服务包括:
-
computers(计算机),对应"计算机与虚拟机" -
exchange(交换),对应"Exchange安全防护"
例如,针对
exchange
服务的请求URL为:
https://YOUR-HOSTNAME/api/v1.0/jsonrpc/quarantine/exchange
参数
|
参数名 |
类型 |
是否可选 |
说明 |
|---|---|---|---|
|
|
字符串 |
是 |
需获取隔离项目的公司ID。 默认值:发起请求所用API密钥所属的公司。 若请求中未包含此参数,响应将显示该API密钥所属公司内所有隔离项目。 |
|
|
字符串 |
是 |
需获取隔离项目的计算机ID。 若请求中未包含此参数,该方法将返回全网隔离的项目。 |
|
|
数字 |
是 |
结果页码。默认值为1。 |
|
|
数字 |
是 |
每页显示项目数。上限为每页100项,默认值为每页30项。 |
|
|
对象 |
是 |
用于查询隔离项列表时的筛选条件。关于可用筛选条件及其使用方法的详细信息,请参阅 可用筛选条件 . |
可用筛选条件
您可以通过
筛选条件
参数按特定属性查询隔离项。
查询结果是匹配所有选定筛选条件的隔离项列表。
以下是可用的筛选选项:
|
字段 |
类型 |
说明 |
|---|---|---|
|
|
字符串 |
按威胁名称筛选隔离项。
该筛选条件适用于
|
|
|
字符串 |
筛选指定日期之后被隔离的项。
日期格式为
该筛选条件适用于
|
|
|
字符串 |
筛选在指定日期之前被隔离的项目。
格式为
此筛选器适用于
|
|
|
字符串 |
按文件路径筛选隔离项目。
此筛选器适用于
|
|
|
字符串 |
按IP地址筛选隔离项目。
此筛选器适用于
|
|
|
整数 |
按操作状态筛选隔离项目。
可用值为
若服务类型为
该筛选器适用于
|
重要说明
-
字段
threatName,filePath和ip支持部分匹配。该过滤器返回完全匹配或以指定值开头的项。若要将指定值用作后缀,请使用星号符号(*)。
例如:
如果
filePath为C:\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, -
详情,与被隔离项目相关的更多信息。有关详情成员内容的信息,请参阅“详情内容” 详情内容 .
-
详情内容
对于
计算机与虚拟机
服务,
详情
字段具有以下结构:
|
字段名称 |
数据类型 |
描述 |
|---|---|---|
|
|
字符串 |
在检测到的终端上,受感染或可疑文件的路径 |
对于
Exchange安全
服务,
详情
字段具有以下结构:
|
字段名称 |
数据类型 |
描述 |
|---|---|---|
|
|
整数 |
检测发生的层级。可能的值:
|
|
|
整数 |
被隔离对象的类型。可能取值:
|
|
|
字符串 |
扫描完成后对象的状态。该状态显示邮件是否为垃圾邮件或包含不受欢迎的内容,或附件是否感染恶意软件、疑似感染、不受欢迎或无法扫描。可能取值为:
|
|
|
对象 |
|
示例
请求 :
{
"params": {"companyId": "55896b87b7894d0f367b23c6","endpointId": "5d36c255f23f730fa91944e2",
"page": 2,
"perPage": 1,
"filters": {
"threatName": "Virus 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": "Computer 1",
"endpointIP": "156.133.37.181",
"canBeRestored": false,
"canBeRemoved": false,
"threatName": "Virus 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": "Computer 1",
"endpointIP": "57.238.160.118",
"endpointAvailable": true,
"threatName": "Virus 0",
"companyId": "55896b87b7894d0f367b23c6",
"details": {
"threatStatus": 4,
"itemType" : 0,
"detectionPoint": 1,
"email": {
"senderIP": "185.36.136.238",
"senderEmail": "test@test.com",
"subject":
"Test subject_5b7d2128b1a43da20c7b23c6",
"recipients": [
"receiver1@test.com", "
receiver2@test.com",
]
"realRecipients": [
"receiver1@test.com", "
receiver2@test.com"
]
}
}
}]
}
}