|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
from
|
Дата начала запрашиваемого периода, в течение которого объекты перемещались в Карантин.
Если параметр не задан, то информация возвращается за текущий месяц.
|
нет
|
id
|
Идентификатор группы
|
да
|
page
|
Номер страницы, которую требуется вернуть в ответе при постраничном отображении (может использоваться для вывода информации о большом количестве объектов в Карантине).
По умолчанию: 1.
|
нет
|
per-page
|
Количество объектов в Карантине на одной странице при постраничном отображении (может использоваться для вывода информации о большом количестве объектов в Карантине).
По умолчанию: 100.
|
нет
|
till
|
Дата конца запрашиваемого периода, в течение которого объекты перемещались в Карантин.
Если параметр не задан, то информация возвращается за текущий месяц.
|
нет
|
Пример запроса
https://192.168.1.1:9081/api/groups/quarantine-objects.ds?id=2&per-page=1
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1587587019" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<group-quarantine items="1" period_from="1585688400" period_till="1587589199">
<item>
<station id="1002">Station02</station>
<created-time>1587553404</created-time>
<component>2</component>
<file size="125440">C:\Users\tests\Virs\Win32.PariteC:\Users\Administrator\Desktop\sendmessage 111\sendmessage\sendmessage\adware._xe</file>
<hash>F20ED9A269BF10E2E9F119979478890C8AA5E6A3F6CD83B2020F27C01991EDF7</hash>
<owner>win7-pro-x64-ru\Administrator:win7-pro-x64-ru\None</owner>
<virus-info>Adware.Dudu</virus-info>
<object>Fc45be5fbe1f9f0b64f9a58fa898b73d913ad494aabb4aa9341c96737600fa44</object>
<q-time>20200422110324000</q-time>
<infection-type>5</infection-type>
</item>
</group-quarantine>
<pages total="6" current="2" objects-per-page="1"/>
</drweb-es-api>
|
Описание параметров ответного XML
•Элемент <group-quarantine /> содержит информацию обо всех объектах в Карантине на станциях группы, указанной в запросе.
Атрибуты элемента <group-quarantine />:
Атрибут
|
Описание
|
items
|
Общее количество объектов в Карантине на станциях заданной группы
|
period_from
|
Дата начала запрашиваемого периода, в течение которого объекты перемещались в Карантин
|
period_till
|
Дата конца запрашиваемого периода, в течение которого объекты перемещались в Карантин
|
▫Элемент <item /> содержит информацию о конкретном объекте Карантина.
▪Элемент <station /> содержит информацию о станции, в Карантин которой был добавлен объект.
Атрибут элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
Значение элемента <station /> — название станции.
▪Значение элемента <created-time /> — время добавления объекта в Карантин на Сервере Dr.Web.
▪Значение элемента <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": 1587592440,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "d43ec7c0-846c-11ea-56fb-d8e582d45004"}},
"data": {
"period_from": 1585688400,
"period_till": 1587675599,
"items": {
"total": 1,
"list": [
{"created_time": 1587553404,
"component_code": 2,
"file": "C:\\Users\\Administrator\\Desktop\\sendmessage 111\\sendmessage\\sendmessage\\adware._xe",
"file_size": 125440,
"hash": "F20ED9A269BF10E2E9F119979478890C8AA5E6A3F6CD83B2020F27C01991EDF7",
"owner": "win7-pro-x64-ru\\Administrator:win7-pro-x64-ru\\None",
"virus_info": "Adware.Dudu",
"object": "Fc45be5fbe1f9f0b64f9a58fa898b73d913ad494aabb4aa9341c96737600fa44",
"q_time": 20200422110324000,
"infection_type": 5,
"station_id": "1002",
"station_name": "Station02"}]},
"pages": {
"total": 6,
"current": 2,
"objects_per_page": 1}}}
|
Описание параметров ответного JSON
Блок data содержит информацию об информацию обо всех объектах в Карантине на станциях группы, указанной в запросе.
Элементы блока data:
Название поля
|
Описание
|
period_from
|
Дата начала запрашиваемого периода, в течение которого объекты перемещались в Карантин
|
period_till
|
Дата конца запрашиваемого периода, в течение которого объекты перемещались в Карантин
|
items
|
Блок с информацией о каждом объекте в Карантине на станциях заданной группы
|
•Элементы блока items:
Название поля
|
Описание
|
total
|
Общее количество объектов в Карантине на всех станциях группы
|
list
|
Массив с информацией по каждому объекту в Карантине
|
▫Каждый объект массива 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
|
Время добавления объекта в Карантин на Сервере Dr.Web
|
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
|
Общее количество страниц
|
|