|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
id
|
Идентификатор группы.
Параметр может быть указан в запросе неограниченное количество раз для запроса информации о нескольких группах одновременно.
|
да
|
from
|
Дата начала периода, за который запрашиваются статистические данные.
Задается в формате: YYYYMMDD или YYYYMMDDHHmmss.
Если параметр не задан, то статистика возвращается за текущий месяц.
|
нет
|
till
|
Дата окончания периода, за который запрашиваются статистические данные.
Задается в формате: YYYYMMDD или YYYYMMDDHHmmss.
Если параметр не задан, то статистика возвращается за текущий месяц.
|
нет
|
Пример запроса
https://192.168.1.1:9081/api/groups/hips_events.ds?id=2
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1587673642" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<groups-hips-events total="1" period_from="1587673642" period_till="1587675599">
<group id="2" name="Group02">
<event stype="1" denied="0" allowed="1"/>
<event stype="3" denied="2" allowed="0"/>
<event stype="4" denied="1" allowed="0"/>
<event stype="8" denied="1" allowed="0"/>
</group>
</groups-hips-events>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <groups-hips-events /> содержит статистику срабатываний Превентивной защиты для всех групп, указанных в запросе.
Атрибуты элемента <groups-hips-events />:
Атрибут
|
Описание
|
total
|
Общее количество групп в ответе
|
period_from
|
Дата начала периода, за который запрашиваются статистические данные
|
period_till
|
Дата окончания периода, за который запрашиваются статистические данные
|
•Элемент <group /> содержит статистику срабатываний Превентивной защиты для конкретной группы.
Атрибуты элемента <group />:
Атрибут
|
Описание
|
id
|
Идентификатор группы
|
name
|
Название группы
|
▫Элементы <event />, вложенные элементы элемента <group />, содержат информацию о конкретном типе событий.
Атрибуты элемента <event />:
Атрибут
|
Описание
|
stype
|
Тип события:
0 — попытка выполнения подозрительного кода,
1 — попытка доступа к защищаемому модулю,
2 — попытка загрузки библиотеки из сетевого пути,
3 — попытка изменения атрибутов защиты стека,
4 — попытка вызова заблокированной функции,
5 — обнаружен некорректный обработчик исключений,
6 — попытка доступа к системному модулю,
7 — попытка доступа к заблокированному адресу (heap spraying),
8 — попытка выполнения кода из неисполняемой памяти.
|
allowed
|
Количество разрешенных действий
|
denied
|
Количество запрещенных действий
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1587673607,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "a38710d0-4cde-11ea-7e2a-088d10f2f970"}},
"data": {
"period_from": 1585688400,
"period_till": 1587675599,
"groups": {
"total": 1,
"list": [
{"id": "2",
"name": "Group02",
"events": [
{"stype": 1,
"allowed": 1,
"denied": 0},
{"stype": 3,
"allowed": 0,
"denied": 2},
{"stype": 4,
"allowed": 0,
"denied": 1},
{"stype": 8,
"allowed": 0,
"denied": 1}]}]}}}
|
Описание параметров ответного JSON
Блок data содержит статистику срабатываний Превентивной защиты для всех групп, указанных в запросе.
Элементы блока data:
Название поля
|
Описание
|
period_from
|
Дата начала периода, за который запрашиваются статистические данные
|
period_till
|
Дата окончания периода, за который запрашивались статистические данные
|
groups
|
Блок со статистикой срабатываний Превентивной защиты для заданных групп
|
•Элементы блока groups:
Название поля
|
Описание
|
total
|
Общее количество групп в ответе
|
list
|
Массив со статистикой срабатываний Превентивной защиты для каждой группы
|
▫Каждый объект массива list содержит статистику срабатываний Превентивной защиты для конкретной группы.
Элементы блока list:
Название поля
|
Описание
|
stype
|
Тип события:
0 — попытка выполнения подозрительного кода,
1 — попытка доступа к защищаемому модулю,
2 — попытка загрузки библиотеки из сетевого пути,
3 — попытка изменения атрибутов защиты стека,
4 — попытка вызова заблокированной функции,
5 — обнаружен некорректный обработчик исключений,
6 — попытка доступа к системному модулю,
7 — попытка доступа к заблокированному адресу (heap spraying),
8 — попытка выполнения кода из неисполняемой памяти.
|
allowed
|
Количество разрешенных действий
|
denied
|
Количество запрещенных действий
|
|