|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
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/groups/statistics.ds?id=20e27d73-d21d-b211-a788-85419c46f0e6
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1588879372" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<groups-statistics total="1" period_from="1588280400" period_till="1588885199">
<group id="20e27d73-d21d-b211-a788-85419c46f0e6" name="Everyone">
<infections scanned="93297843" total="52351084">
<modifications>0</modifications>
<suspicious>2</suspicious>
<activities>0</activities>
<cured>11773944</cured>
<moved>11781181</moved>
<renamed>0</renamed>
<deleted>11779308</deleted>
<locked>0</locked>
<errors>46174597</errors>
</infections>
<viruses>
<virus name="IO2V2.KpRKF.LZXzuk1ssY" stations="1" originator=37" treatment=9">2</virus>
<virus name="125F.FtE6OP7.37688" stations="1" originator=37" treatment=1025">1</virus>
<virus name="16aE.Il9509.17776" stations="1" originator=37" treatment=514">1</virus>
<virus name="05z9Y.5jZetG" stations="1" originator=37" treatment=2049">1</virus>
<virus name="0T5q.C28VO.5360" stations="1" originator=37" treatment=9">1</virus>
<virus name="11qp.d8SNO6.17481" stations="1" originator=37" treatment=2049">1</virus>
<virus name="0BUG5y.ekHPE.28147" stations="1" originator=37" treatment=2049">1</virus>
<virus name="10Qp.lVZE.ELByVcwf6R.43711" stations="1" originator=37" treatment=9">1</virus>
<virus name="i5S1.hI2emvT8.76WQs.54360" stations="1" originator=37" treatment=9">2</virus>
<virus name="fZVa.QRwL.16169" stations="1" originator=37" treatment=513">2</virus>
</viruses>
</group>
</groups-statistics>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <groups-statistics /> содержит статистику станций групп, указанных в запросе.
Атрибуты элемента <groups-statistics />:
Атрибут
|
Описание
|
total
|
Общее количество групп в ответе
|
period_from
|
Дата начала периода, за который выводятся статистические данные
|
period_till
|
Дата окончания периода, за который выводятся статистические данные
|
•Элемент <group /> содержит информацию о конкретной группе.
Атрибуты элемента <group />:
Атрибут
|
Описание
|
id
|
Идентификатор группы
|
name
|
Название группы
|
▫Элемент <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": 1588883331,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},
"data": {
"period_from": 1588280400,
"period_till": 1588885199,
"groups": {
"total": 1,
"list": [
{"id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"infections": {
"scanned": 93297843,
"infected": 52351084,
"modifications": 0,
"suspicious": 2,
"activities": 0,
"cured": 11773944,
"moved": 11781181,
"deleted": 11779308,
"renamed": 0,
"locked": 0,
"errors": 46174597},
"viruses": {
"11qp.d8SNO6.17481": 1,
"16aE.Il9509.17776": 1,
"fZVa.QRwL.16169": 2,
"05z9Y.5jZetG": 1,
"125F.FtE6OP7.37688": 1,
"i5S1.hI2emvT8.76WQs.54360": 2,
"0BUG5y.ekHPE.28147": 1,
"10Qp.lVZE.ELByVcwf6R.43711": 1,
"IO2V2.KpRKF.LZXzuk1ssY": 2,
"0T5q.C28VO.5360": 1},
"viruses_info": {
"11qp.d8SNO6.17481": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 2049},
"16aE.Il9509.17776": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 514},
"fZVa.QRwL.16169": {
"count": 2,
"originator": 37,
"stations": 1,
"treatment": 513},
"05z9Y.5jZetG": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 2049},
"125F.FtE6OP7.37688": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 1025},
"i5S1.hI2emvT8.76WQs.54360": {
"count": 2,
"originator": 37,
"stations": 1,
"treatment": 9},
"0BUG5y.ekHPE.28147": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 2049},
"10Qp.lVZE.ELByVcwf6R.43711": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 9},
"IO2V2.KpRKF.LZXzuk1ssY": {
"count": 2,
"originator": 37,
"stations": 1,
"treatment": 9},
"0T5q.C28VO.5360": {
"count": 1,
"originator": 37,
"stations": 1,
"treatment": 9}},
"name": "Everyone"}}}]}}}
|
Описание параметров ответного JSON
Блок data содержит статистику станций всех групп, указанных в запросе.
Элементы блока data:
Название поля
|
Описание
|
period_from
|
Дата начала периода, за который запрашивались статистические данные
|
period_till
|
Дата окончания периода, за который запрашивались статистические данные
|
groups
|
Блок со статистикой станций заданных групп
|
•Блок groups содержит информацию обо всех заданных группах.
Элементы блока groups:
Название поля
|
Описание
|
total
|
Общее количество групп
|
list
|
Массив с информацией для каждой группы
|
▫Каждый объект массива list содержит информацию о конкретной группе.
Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор группы
|
infections
|
Блок со статистикой по обнаруженным инфекциям
|
viruses
|
Блок со статистикой по обнаруженным угрозам
|
viruses_info
|
Блок со статистикой по каждой из обнаруженных угроз
|
name
|
Название группы
|
▪Элементы блока infections:
Название поля
|
Описание
|
modifications
|
Количество объектов, инфицированных модификациями угроз
|
suspicious
|
Количество подозрительных объектов
|
activities
|
Количество вредоносных действий
|
cured
|
Количество вылеченных объектов
|
deleted
|
Количество удаленных объектов
|
errors
|
Количество ошибок при сканировании
|
infected
|
Количество зараженных объектов
|
locked
|
Количество заблокированных объектов
|
moved
|
Количество объектов, перемещенные в Карантин
|
renamed
|
Количество переименованных объектов
|
scanned
|
Общее количество просканированных файлов
|
▪Элементы блока viruses:
Название поля
|
Описание
|
Название обнаруженной угрозы
|
Количество объектов, на которых обнаружена данная угроза
|
▪Элементы блока viruses_info:
Название поля
|
Описание
|
count
|
Количество объектов, на которых обнаружена данная угроза
|
originator
|
Код компонента, который обнаружил угрозу
|
stations
|
Количество станций, на которых обнаружена данная угроза
|
treatment
|
Код действия, примененного к угрозе и зависящего от ее типа
|
|