Параметры запроса
Параметр
|
Описание
|
Обязательный
|
from
|
Начало запрашиваемого периода, в течение которого объекты перемещались в Карантин
|
нет
|
id
|
Идентификатор группы для получения информации об объектах Карантина на станциях этой группы
|
да
|
page
|
Номер страницы, которую требуется вернуть в ответе при постраничном отображении (может использоваться для вывода информации о большом количестве станций)
|
нет
|
per-page
|
Количество станций на одной странице при постраничном отображении (может использоваться для вывода информации о большом количестве станций)
|
нет
|
till
|
Конец запрашиваемого периода, в течение которого объекты перемещались в Карантин
|
нет
|
Пример запроса
http://192.168.1.1:9080/api/groups/quarantine-objects.ds?id=30cc7eb2-d11d-b211-b695-b80815e63511&from=20190531&till=20190614&page=1&per-page=3
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.0" timestamp="1560513283" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<group-quarantine items="1" period_from="1559314800" period_till="1560524399">
<item>
<station id="9d09ba10-8c30-11e9-476d-bcdfc107a5ed">T-PC</station>
<created-time>1560247639</created-time>
<component>11</component>
<file size="226592">C:\Users\tests\Virs_Samples\Adware\dprawex.#l</file>
<hash>0B12DF889C995EAE30FDAA6AEFBCA6896946889D9AE105E9C21359C2F3C48E45</hash>
<owner>tests-pc\tests:tests-pc\None</owner>
<virus-info>Adware.Look2me</virus-info>
<object>F165CBF1C530C32147A070211842E753CE9104B4C3A7F1A74FE1B83BF8BDA5F0</object>
<q-time>20190611100719446</q-time>
<infection-type>5</infection-type>
</item>
</group-quarantine>
<pages total="1" current="1" objects-per-page="3"/>
</drweb-es-api>
|
Описание параметров ответного XML
•Элемент <group-quarantine /> содержит информацию об объектах, находящихся в Карантине на станциях заданной группы. Атрибуты элемента <group-quarantine />:
Атрибут
|
Описание
|
items
|
Общее количество объектов в Карантине на всех станциях заданной группы
|
period_from
|
Начало запрашиваемого периода, в течение которого объекты перемещались в Карантин
|
period_till
|
Конец запрашиваемого периода, в течение которого объекты перемещались в Карантин
|
▫Элемент <item /> содержит информацию о конкретном объекте Карантина. ▪Элемент <station /> содержит информацию о конкретных станциях заданной группы. Атрибут элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции, информация о Карантине которой приводится в данной секции <item />
|
Значение элемента <station /> — имя станции, информация о Карантине которой приводится в данной секции.
▪Значение элемента <created-time /> — время добавления объекта в Карантин на Сервере. ▪Значение элемента <component /> — код компонента, переместившего объект в Карантин:
Код
|
Компонент
|
0
|
неизвестный компонент
|
1
|
Сканер Dr.Web
|
2
|
SpIDer Guard
|
3
|
SpIDer Mail
|
4
|
SpIDer Gate
|
5
|
Менеджер карантина
|
6
|
Dr.Web для Kerio
|
7
|
Dr.Web для Microsoft Outlook
|
8
|
Dr.Web для IBM Lotus Domino
|
9
|
Dr.Web для Qbik WinGate
|
10
|
Dr.Web для ISA Server
|
11
|
Антируткит-модуль
|
•Элемент <file /> содержит информацию о конкретном файле, находящемся в Карантине. Атрибут элемента <file />:
Атрибут
|
Описание
|
size
|
Размер файла, находящегося в Карантине
|
Значение элемента <file /> — оригинальное имя файла и полный путь к файлу до перемещения в Карантин.
•Значение элемента <hash /> — хеш-код объекта в формате SHA256. •Значение элемента <owner /> — имя пользователя-владельца файла. •Значение элемента <virus-info /> — название вредоносного объекта по классификации компании «Доктор Веб». •Значение элемента <object /> — идентификатор объекта после перемещения в Карантин. •Значение элемента <q-time /> — время добавления объекта в Карантин на станции. •Значение элемента <infection-type /> — тип инфекции. Типам инфекций присвоены следующие коды:
Код
|
Тип инфекции
|
1
|
известная инфекция
|
2
|
известная модификация инфекции
|
4
|
неизвестная инфекция
|
5
|
рекламная программа
|
6
|
программа дозвона
|
7
|
программа-шутка
|
8
|
потенциально опасная программа
|
9
|
программа взлома
|
•Элемент <pages /> содержит информацию о постраничном отображении состояния Карантина. Атрибуты элемента <pages />:
Атрибут
|
Описание
|
total
|
Всего страниц с информацией о состоянии Карантина при постраничном выводе
|
current
|
Номер текущей страницы
|
objects-per-page
|
Количество объектов на странице
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1560513328,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "76b05bc0-8691-11e9-63e5-7036cecd07fa"}},
"data": {
"period_from": 1559314800,
"period_till": 1560524399,
"items": {
"total": 1,
"list": [
{"component_code": 11,
"created_time": 1560247639,
"file": "C:\\Users\\tests\\Virs_Samples\\Adware\\dprawex.#l",
"file_size": 226592,
"hash": "0B12DF889C995EAE30FDAA6AEFBCA6896946889D9AE105E9C21359C2F3C48E45",
"infection_type": 5,
"object": "F165CBF1C530C32147A070211842E753CE9104B4C3A7F1A74FE1B83BF8BDA5F0",
"owner": "tests-pc\\tests:tests-pc\\None",
"q_time": 20190611100719446,
"station_id": "9d09ba10-8c30-11e9-476d-bcdfc107a5ed",
"station_name": "T-PC",
"virus_info": "Adware.Look2me"}]},
"pages": {
"current": 1,
"objects_per_page": 3,
"total": 1}}}
|
Описание параметров ответного JSON
Блок data содержит общую информацию о запросе и блоки с информацией об объектах, находящихся в Карантине.
Элементы блока data:
Название поля
|
Описание
|
period_from
|
Начало запрашиваемого периода, в течение которого объекты перемещались в Карантин
|
period_till
|
Конец запрашиваемого периода, в течение которого объекты перемещались в Карантин
|
•Блок items содержит информацию об объектах, находящихся в Карантине на станциях заданной группы. Элементы блока items:
Название поля
|
Описание
|
total
|
Общее количество объектов в Карантине на всех станциях заданной группы
|
▫Массив list содержит информацию о конкретных объектах Карантина. Элементы объектов в массиве list:
Название поля
|
Описание
|
component_code
|
Код компонента, переместившего объект в Карантин:
0 — неизвестный компонент,
1 — Сканер Dr.Web,
2 — SpIDer Guard,
3 — SpIDer Mail,
4 — SpIDer Gate,
5 — Менеджер Карантина,
6 — Dr.Web для Kerio,
7 — Dr.Web для Microsoft Outlook,
8 — Dr.Web для IBM Lotus Domino,
9 — Dr.Web для Qbik WinGate,
10 — Dr.Web для ISA Server,
11 — Антируткит-модуль
|
created_time
|
Время добавления объекта в Карантин на Сервере
|
file
|
Оригинальное имя файла и полный путь к файлу до перемещения в Карантин
|
file_size
|
Размер файла, находящегося в Карантине
|
hash
|
Хеш-код объекта в формате SHA256
|
infection_type
|
Тип инфекции:
1 — известная инфекция,
2 — известная модификация инфекции,
4 — неизвестная инфекция,
5 — рекламная программа,
6 — программа дозвона,
7 — программа-шутка,
8 — потенциально опасная программа,
9 — программа взлома
|
object
|
Идентификатор объекта после перемещения в Карантин
|
owner
|
Имя пользователя-владельца файла
|
q_time
|
Время добавления объекта в Карантин на станции
|
station_id
|
Идентификатор станции, информация о Карантине которой приводится в данной секции
|
station_name
|
Имя станции, информация о Карантине которой приводится в данной секции
|
virus_info
|
Название вредоносного объекта по классификации компании «Доктор Веб»
|
•Блок pages содержит информацию о количестве выводимых записей. Элементы блока pages:
Название поля
|
Описание
|
current
|
Номер текущей страницы
|
objects_per_page
|
Количество записей на одной странице
|
total
|
Общее количество страниц
|
|