Получение статистики срабатывания Превентивной защиты

Параметры запроса

Параметр

Описание

Обязательный

id

Идентификатор станции.

Параметр может быть указан в запросе неограниченное количество раз для запроса информации о нескольких станциях одновременно.

да

from

Дата начала периода, за который запрашиваются статистические данные.

Задается в формате: YYYYMMDD или YYYYMMDDHHmmss.
Если параметр не задан, то статистика возвращается за текущий месяц.

нет

till

Дата окончания периода, за который запрашиваются статистические данные.

Задается в формате: YYYYMMDD или YYYYMMDDHHmmss.
Если параметр не задан, то статистика возвращается за текущий месяц.

нет

 

Пример запроса

https://192.168.1.1:9081/api/stations/hips_events.ds?id=1002

Ниже представлены примеры ответов в формате 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">
  <stations-hips-events total="1" period_from="1587673642" period_till="1587675599">
     <station id="1002" name="Station02">
        <event stype="1" denied="0" allowed="3"/>

        <event stype="3" denied="2" allowed="0"/>

        <event stype="4" denied="2" allowed="1"/>

        <event stype="0" denied="0" allowed="1"/>

        <event stype="8" denied="1" allowed="1"/>
     </station>
  </stations-hips-events>
</drweb-es-api>

 

Описание параметров ответного XML

Элемент <stations-hips-events /> содержит статистику срабатываний Превентивной защиты на всех станциях, указанных в запросе.

Атрибуты элемента <stations-hips-events />:

Атрибут

Описание

total

Общее количество станций в ответе

period_from

Дата начала периода, за который запрашиваются статистические данные

period_till

Дата окончания периода, за который запрашиваются статистические данные

Элемент <station /> содержит статистику срабатываний Превентивной защиты для конкретной станции.

Атрибуты элемента <station />:

Атрибут

Описание

id

Идентификатор станции

name

Название станции

Элементы <event />, вложенные элементы элемента <station />, содержат информацию о конкретном типе событий.

Атрибуты элемента <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,

    "stations": {
      "total": 1,

      "list": [
          {"id": "1002",

          "name": "Station02",

          "events": [
             {"stype": 1,

              "allowed": 3,

              "denied": 0},

             {"stype": 3,

              "allowed": 0,

              "denied": 2},

             {"stype": 4,

              "allowed": 1,

              "denied": 2},

             {"stype": 0,

              "allowed": 1,

              "denied": 0},

             {"stype": 8,

              "allowed": 1,

              "denied": 1}]}]}}}

 

Описание параметров ответного JSON

Блок data содержит статистику срабатываний Превентивной защиты.

Элементы блока data:

Название поля

Описание

period_from

Дата начала периода, за который запрашиваются статистические данные

period_till

Дата окончания периода, за который запрашивались статистические данные

stations

Блок со статистикой срабатываний Превентивной защиты для всех станций, указанных в запросе

Элементы блока stations:

Название поля

Описание

total

Общее количество станций в ответе

list

Массив со статистикой срабатываний Превентивной защиты для каждой станции

Каждый объект массива list содержит статистику срабатываний Превентивной защиты для конкретной станции.

Элементы массива list:

Название поля

Описание

stype

Тип события:

0 — попытка выполнения подозрительного кода,

1 — попытка доступа к защищаемому модулю,

2 — попытка загрузки библиотеки из сетевого пути,

3 — попытка изменения атрибутов защиты стека,

4 — попытка вызова заблокированной функции,

5 — обнаружен некорректный обработчик исключений,

6 — попытка доступа к системному модулю,

7 — попытка доступа к заблокированному адресу (heap spraying),

8 — попытка выполнения кода из неисполняемой памяти.

allowed

Количество разрешенных действий

denied

Количество запрещенных действий