Получение статистики Сервера по обнаруженным угрозам

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

Параметр

Описание

Допустимые значения

Примечание

from

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

Задается в формате: YYYYMMDD или YYYYMMDDHHmmss

Обязательный параметр: нет.

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

till

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

Задается в формате: YYYYMMDD или YYYYMMDDHHmmss

Обязательный параметр: нет.

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

top-viruses

Топ вирусов

yes | no

Обязательный параметр: нет.

По умолчанию no

virtop

Количество вирусов в топ вирусов

Целое положительное число

Обязательный параметр: нет.

По умолчанию 10, параметр будет игнорироваться, если top-viruses=no.

 

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

http://192.168.1.1:9080/api/server/statistics.ds?virtop=100&top-viruses=yes&from=1567285200&till=1569877199

Ниже представлены примеры ответов в формате XML и в формате JSON.

 

Ответ в формате XML

<drweb-es-api api_version="4.3.0" timestamp="1569835428" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <server-statistics period_from="1567285200" period_till="1569877199">
     <infections scanned="72" total="16">

        <modifications>0</modifications>

        <suspicious>1</suspicious>

        <activities>0</activities>

        <cured>0</cured>

        <moved>7</moved>

        <renamed>0</renamed>

        <deleted>0</deleted>

        <locked>0</locked>
        <errors>7</errors>
     </infections>

     <viruses>
        <virus name="HLLP.Setart.19919" stations="1" originator=57" treatment=9">1</virus>

        <virus name="EICAR Test File (NOT a Virus!)" stations="1" originator=57" treatment=1049605">1</virus>

        <virus name="Dialer.Adultparty" stations="1" originator=57" treatment=1049605">1</virus>

        <virus name="Adware.Dudu" stations="1" originator=57" treatment=1049605">1</virus>

        <virus name="Program.2Spy" stations="1" originator=4" treatment=1">2</virus>
     </viruses>
  </server-statistics>
  <stations></stations>
</drweb-es-api>

 

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

Элемент <server-statistics /> содержит информацию о статистике Сервера.

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

Атрибут

Описание

period_from

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

period_till

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

Элемент <infections /> содержит статистику по действиям над обнаруженными объектами.

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

Атрибут

Описание

scanned

Общее количество просканированных объектов

total

Общее количество обнаруженных инфекций

Вложенные элементы элемента <infections />:

Элемент

Описание

<modifications />

Количество объектов, инфицированных модификациями вирусов

<suspicious />

Количество подозрительных объектов

<activities />

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

<cured />

Количество вылеченных объектов

<moved />

Количество объектов, перемещенные в карантин

<renamed />

Количество переименованных объектов

<deleted />

Количество удаленных объектов

<locked />

Количество заблокированных объектов

<errors />

Количество ошибок при сканировании

Значением данных  элементов является количество объектов, над которыми было совершенно действие, соответствующее данному элементу.

Элемент <viruses /> содержит статистику по всем обнаруженным вирусам.

Элемент <virus /> содержит информацию о конкретном вирусе. Значение элемента <virus /> — количество объектов, зараженных данным вирусом.

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

Атрибут

Описание

name

Название вируса

stations

Количество станций, зараженных данным вирусом

originator

Код компонента, который обнаружил вирус

treatment

Код действия, примененного к вирусу и зависящего от его типа

 

Ответ в формате JSON

{ "head": {
    "status": true,

    "timestamp": 1569834553,

    "api": {
      "version": 40300,
      "versionString": 4.3.0},

    "server": {
      "name": "192.168.1.1",

      "version": "12.00.0.201909260",
      "uuid": "99e24f80-e35d-11e9-64e2-b45638e9b982"}},

 "data": {
    "period_till": 1569877199,

    "period_from": 1567285200,

    "infections": {
      "scanned": 72,

      "infected": 16,

      "modifications": 0,

      "suspicious": 1,

      "activities": 0,

      "cured": 0,

      "moved": 7,

      "deleted": 0,

      "renamed": 0,

      "locked": 0,
      "errors": 7},

    "viruses": {
      "Dialer.Adultparty": 1,

      "HLLP.Setart.19919": 1,

      "Adware.Dudu": 1,

      "Program.2Spy": 2,

      "EICAR Test File (NOT a Virus!)": 1},

    "viruses_info": {
      "Dialer.Adultparty": {
          "count": 1,
          "originator": 57,
          "stations": 1,
          "treatment": 1049605},

      "HLLP.Setart.19919": {
          "count": 1,
          "originator": 57,
          "stations": 1,
          "treatment": 9},

      "Adware.Dudu": {
          "count": 1,
          "originator": 57,
          "stations": 1,
          "treatment": 1049605},

      "Program.2Spy": {
          "count": 2,
          "originator": 4,
          "stations": 1,
          "treatment": 1},

      "EICAR Test File (NOT a Virus!)": {
          "count": 1,
          "originator": 57,
          "stations": 1,
          "treatment": 1049605}}}}

 

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

Блок data содержит общую информацию о запросе и блоки с запрошенной информацией о Сервере.

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

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

Описание

period_from

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

period_till

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

Блок infections содержит статистику по действиям над обнаруженными объектами.

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

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

Описание

scanned

Общее количество просканированных файлов

infected

Количество зараженных объектов

modifications

Количество объектов, инфицированных модификациями вирусов

suspicious

Количество подозрительных объектов

activities

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

cured

Количество вылеченных объектов

moved

Количество объектов, перемещенные в карантин

deleted

Количество удаленных объектов

renamed

Количество переименованных объектов

locked

Количество заблокированных объектов

errors

Количество ошибок при сканировании

Блок viruses содержит статистику по всем обнаруженным вирусам. Названия полей соответствуют названиям обнаруженных вирусов, значение каждого поля содержит количество зараженных объектов.

Блок viruses_info содержит статистику по каждому из обнаруженных вирусов.

Элементы блока с названием обнаруженного вируса:

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

Описание

count

Количество объектов, зараженных данным вирусом

originator

Код компонента, который обнаружил вирус

stations

Количество станций, зараженных данным вирусом

treatment

Код действия, примененного к вирусу и зависящего от его типа