|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
from
|
Дата начала периода, за который запрашивается статистика.
Задается в формате: YYYYMMDD или YYYYMMDDHHmmss.
Если параметр не задан, то статистика возвращается за текущий месяц.
|
нет
|
till
|
Дата окончания периода, за который запрашивается статистика.
Задается в формате: YYYYMMDD или YYYYMMDDHHmmss.
Если параметр не задан, то статистика возвращается за текущий месяц.
|
нет
|
top-viruses
|
Топ угроз.
Допустимые значения: yes | no. По умолчанию: yes.
|
нет
|
virtop
|
Количество угроз в топ угроз.
Допустимые значения: целое положительное число. По умолчанию: 10.
Параметр будет игнорироваться, если top-viruses=no.
|
нет
|
Пример запроса
https://192.168.1.1:9081/api/server/statistics.ds?virtop=100&top-viruses=yes
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1587315430" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<server-statistics period_from="1585688400" period_till="1587329999">
<infections scanned="7864" total="2">
<modifications>0</modifications>
<suspicious>0</suspicious>
<activities>2</activities>
<cured>0</cured>
<moved>0</moved>
<renamed>0</renamed>
<deleted>2</deleted>
<locked>0</locked>
<errors>2767</errors>
</infections>
<viruses>
<virus name="EICAR Test File (NOT a Virus!)" stations="1" originator=115" treatment=513">2</virus>
</viruses>
</server-statistics>
<stations></stations>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <server-statistics /> содержит информацию о статистике Сервера Dr.Web.
Атрибуты элемента <server-statistics />:
Атрибут
|
Описание
|
period_from
|
Дата начала периода, за который приведена статистика
|
period_till
|
Дата окончания периода, за который приведена статистика
|
•Элемент <infections /> содержит статистику по действиям над обнаруженными объектами.
Атрибуты элемента <infections />:
Атрибут
|
Описание
|
scanned
|
Общее количество просканированных объектов
|
total
|
Общее количество обнаруженных инфекций
|
▫Вложенные элементы элемента <infections />:
Элемент
|
Описание
|
<modifications />
|
Количество объектов, инфицированных модификациями угроз
|
<suspicious />
|
Количество подозрительных объектов
|
<activities />
|
Количество вредоносных действий
|
<cured />
|
Количество вылеченных объектов
|
<moved />
|
Количество объектов, перемещенные в Карантин
|
<renamed />
|
Количество переименованных объектов
|
<deleted />
|
Количество удаленных объектов
|
<locked />
|
Количество заблокированных объектов
|
<errors />
|
Количество ошибок при сканировании
|
Значением данных элементов является количество объектов, над которыми было совершенно действие, соответствующее данному элементу.
•Элемент <viruses /> содержит статистику по всем обнаруженным угрозам.
▫Элемент <virus /> содержит информацию о конкретной угрозе.
Атрибуты элемента <virus />:
Атрибут
|
Описание
|
name
|
Название угрозы
|
stations
|
Количество станций, на которых обнаружена данная угроза
|
originator
|
Код компонента, который обнаружил угрозу
|
treatment
|
Код действия, примененного к угрозе и зависящего от ее типа
|
Значение элемента <virus /> — количество объектов, на которых обнаружена данная угроза.
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1587315538,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},
"data": {
"period_till": 1587329999,
"period_from": 1585688400,
"infections": {
"scanned": 7864,
"infected": 2,
"modifications": 0,
"suspicious": 0,
"activities": 2,
"cured": 0,
"moved": 0,
"deleted": 2,
"renamed": 0,
"locked": 0,
"errors": 2767},
"viruses": {
"EICAR Test File (NOT a Virus!)": 2},
"viruses_info": {
"EICAR Test File (NOT a Virus!)": {
"count": 2,
"originator": 115,
"stations": 1,
"treatment": 513}}}}
|
Описание параметров ответного JSON
Блок data содержит информацию о статистике Сервера Dr.Web.
Элементы блока data:
Название поля
|
Описание
|
period_from
|
Дата начала периода, за который запрашивались статистические данные
|
period_till
|
Дата окончания периода, за который запрашивались статистические данные
|
infections
|
Блок со статистикой по действиям над обнаруженными объектами
|
viruses
|
Блок с суммарной статистикой по всем обнаруженным угрозам
|
viruses_info
|
Блок со статистикой по каждой из обнаруженных угроз
|
•Элементы блока infections:
Название поля
|
Описание
|
scanned
|
Общее количество просканированных файлов
|
infected
|
Количество зараженных объектов
|
modifications
|
Количество объектов, инфицированных модификациями угроз
|
suspicious
|
Количество подозрительных объектов
|
activities
|
Количество вредоносных действий
|
cured
|
Количество вылеченных объектов
|
moved
|
Количество объектов, перемещенные в Карантин
|
deleted
|
Количество удаленных объектов
|
renamed
|
Количество переименованных объектов
|
locked
|
Количество заблокированных объектов
|
errors
|
Количество ошибок при сканировании
|
•Элементы блока viruses:
Название поля
|
Описание
|
Название обнаруженной угрозы
|
Количество зараженных объектов
|
•Блок viruses_info состоит из вложенных блоков.
▫Каждый вложенный блок содержит статистику по каждой из обнаруженных угроз. Название вложенного блока соответствует названию обнаруженной угрозы.
Элементы вложенных блоков в блоке viruses_info:
Название поля
|
Описание
|
count
|
Количество объектов, на которых обнаружена данная угроза
|
originator
|
Код компонента, который обнаружил угрозу
|
stations
|
Количество станций, на которых обнаружена данная угроза
|
treatment
|
Код действия, примененного к угрозе и зависящего от ее типа
|
|