|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
id
|
Идентификатор станции.
Параметр может быть указан в запросе неограниченное количество раз для запроса информации о нескольких станциях одновременно.
|
да
|
from
|
Дата начала периода, за который запрашиваются статистические данные.
Задается в формате: YYYYMMDD или YYYYMMDDHHmmss.
Если параметр не задан, то статистика возвращается за текущий месяц.
|
нет
|
till
|
Дата окончания периода, за который запрашиваются статистические данные
Задается в формате: YYYYMMDD или YYYYMMDDHHmmss.
Если параметр не задан, то статистика возвращается за текущий месяц.
|
нет
|
top-viruses
|
Если параметр имеет значение yes, то в ответе будет приведена информация о наиболее часто встречающихся вирусах.
Допустимые значения: yes | no. По умолчанию: yes.
|
нет
|
virtop
|
Количество вирусов в топ вирусов.
Допустимые значения: целое положительное число. По умолчанию: 10.
Параметр будет игнорироваться, если top-viruses=no.
|
нет
|
Пример запроса
https://192.168.1.1:9081/api/stations/statistics.ds?id=1002&virtop=5&top-viruses=yes
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1587653647" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<stations-statistics total="1" period_from="1585688400" period_till="1587675599">
<station id="1002" name="WIN7-PRO-X64-RU">
<infections scanned="2697" total="12">
<modifications>0</modifications>
<suspicious>2</suspicious>
<activities>0</activities>
<cured>1</cured>
<moved>5</moved>
<renamed>0</renamed>
<deleted>0</deleted>
<locked>0</locked>
<errors>0</errors>
</infections>
<viruses>
<virus name="Adware.Dudu" originator="57" treatment="1049605">1</virus>
<virus name="Dialer.Adultparty" originator="57" treatment="1049605">1</virus>
<virus name="EICAR Test File (NOT a Virus!)" originator="57" treatment="1049605">1</virus>
<virus name="HLLP.Setart.19919" originator="57" treatment="1049605">1</virus>
<virus name="Joke.EjectCd" originator="57" treatment="1049605">1</virus>
</viruses>
</station>
</stations-statistics>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <stations-statistics /> содержит статистику всех станций, указанных в запросе.
Атрибуты элемента <stations-statistics />:
Атрибут
|
Описание
|
total
|
Общее количество станций в ответе
|
period_from
|
Дата начала периода, за который запрашиваются статистические данные
|
period_till
|
Дата окончания периода, за который запрашиваются статистические данные
|
•Элемент <station /> содержит информацию о конкретной станции.
Атрибуты элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
name
|
Название станции
|
▫Элемент <infections /> содержит статистику по обнаруженным инфекциям.
Атрибуты элемента <infections />:
Атрибут
|
Описание
|
scanned
|
Общее количество просканированных файлов
|
total
|
Общее количество инфекций
|
▪Вложенные элементы элемента <infections />:
Элемент
|
Описание
|
<modifications />
|
Количество объектов, инфицированных модификациями вирусов
|
<suspicious />
|
Количество подозрительных объектов
|
<activities />
|
Количество вредоносных действий
|
<cured />
|
Количество вылеченных объектов
|
<moved />
|
Количество объектов, перемещенных в Карантин
|
<renamed />
|
Количество переименованных объектов
|
<deleted />
|
Количество удаленных объектов
|
<locked />
|
Количество заблокированных объектов
|
<errors />
|
Количество ошибок при сканировании
|
▫Элемент <viruses /> содержит статистику по обнаруженным вирусам.
▪Элемент <virus /> содержит информацию о конкретном вирусе.
Атрибуты элемента <virus />:
Атрибут
|
Описание
|
name
|
Название вируса
|
originator
|
Код компонента, который обнаружил вирус
|
treatment
|
Код действия, примененного к вирусу и зависящего от его типа
|
Значение элемента <virus /> — количество объектов, зараженных данным вирусом.
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1587653710,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "6d8f5aa0-850a-11ea-4c3c-c8efa441e4dd"}},
"data": {
"period_from": 1585688400,
"period_till": 1587675599,
"stations": {
"total": 1,
"list": [
{"id": "1002",
"infections": {
"scanned": 2697,
"infected": 12,
"modifications": 0,
"suspicious": 2,
"activities": 0,
"cured": 1,
"moved": 5,
"deleted": 0,
"renamed": 0,
"locked": 0,
"errors": 0},
"viruses": {
"Adware.Dudu": 1,
"Dialer.Adultparty": 1,
"EICAR Test File (NOT a Virus!)": 1,
"HLLP.Setart.19919": 1,
"Joke.EjectCd": 1},
"viruses_info": {
"Adware.Dudu": {
"count": 1,
"originator": 57,
"stations": 1,
"treatment": 1049605},
"Dialer.Adultparty": {
"count": 1,
"originator": 57,
"stations": 1,
"treatment": 1049605},
"EICAR Test File (NOT a Virus!)": {
"count": 1,
"originator": 57,
"stations": 1,
"treatment": 1049605},
"HLLP.Setart.19919": {
"count": 1,
"originator": 57,
"stations": 1,
"treatment": 1049605},
"Joke.EjectCd": {
"count": 1,
"originator": 57,
"stations": 1,
"treatment": 1049605}},
"name": "WIN7-PRO-X64-RU"}]}}}
|
Описание параметров ответного JSON
Блок data содержит статистику всех станций, указанных в запросе.
Элементы блока data:
Название поля
|
Описание
|
period_from
|
Дата начала периода, за который запрашиваются статистические данные
|
period_till
|
Дата окончания периода, за который запрашивались статистические данные
|
stations
|
Блок со статистикой всех станций, указанных в запросе
|
•Элементы блока stations:
Название поля
|
Описание
|
total
|
Общее количество станций в ответе
|
list
|
Массив со статистикой для каждой станции
|
▫Каждый элемент массива list содержит статистику конкретной станции.
Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор станции
|
infections
|
Блок со статистикой по всем обнаруженным инфекциям
|
viruses
|
Блок со статистикой по всем обнаруженным вирусам. Названия полей соответствуют названиям обнаруженных вирусов, значение каждого поля содержит количество зараженных объектов.
|
viruses_info
|
Блок со статистикой по каждому из обнаруженных вирусов
|
name
|
Название станции
|
▪Элементы блока infections:
Название поля
|
Описание
|
scanned
|
Общее количество просканированных файлов
|
infected
|
Количество зараженных объектов
|
modifications
|
Количество объектов, инфицированных модификациями вирусов
|
suspicious
|
Количество подозрительных объектов
|
activities
|
Количество вредоносных действий
|
cured
|
Количество вылеченных объектов
|
moved
|
Количество объектов, перемещенные в Карантин
|
deleted
|
Количество удаленных объектов
|
renamed
|
Количество переименованных объектов
|
locked
|
Количество заблокированных объектов
|
errors
|
Количество ошибок при сканировании
|
▪Элементы блока viruses_info:
Название поля
|
Описание
|
count
|
Количество объектов, зараженных данным вирусом
|
originator
|
Код компонента, который обнаружил вирус
|
stations
|
Количество станций, зараженных данным вирусом
|
treatment
|
Код действия, примененного к вирусу и зависящего от его типа
|
|