Получение состояния Карантина

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

Параметр

Описание

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

from

Начало запрашиваемого периода, в течение которого объекты перемещались в Карантин

нет

id

Идентификатор станции для получения информации об объектах Карантина этой станции

да

page

Номер страницы, которую требуется вернуть в ответе при постраничном отображении (может использоваться для вывода информации о большом количестве станций)

нет

per-page

Количество станций на одной странице при постраничном отображении (может использоваться для вывода информации о большом количестве станций)

нет

till

Конец запрашиваемого периода, в течение которого объекты перемещались в Карантин

нет

 

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

http://192.168.1.1:9080/api/stations/quarantine-objects.ds?id=2091ada3-ed5e-e611-3392-f0b9022a5484&from=20190531&till=20190614&page=2&per-page=2

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

 

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

<drweb-es-api api_version="4.3.0" timestamp="1560513442" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
 <group-quarantine items="100" period_from="1559314800" period_till="1560524399">
   <item>
     <created-time>1560513439</created-time>

     <component>7</component>

     <file size="860362">C:\Users\tests\Virs\Win32.Parite.2\postcard.gif.ex#</file>

     <hash>gOD2zZJlSOzAq5mwHe7LRRlFRO9ngUSd</hash>

     <owner>tests-pc\tests:tests-pc\None</owner>

     <virus-info>IRC.Flood</virus-info>

     <object>8f7b2c47-8e9b-11e9-5812-dcfdccec8a94</object>

     <q-time>20190614115718980</q-time>
     <infection-type>1</infection-type>
   </item>

   <item>
     <created-time>1560513436</created-time>

     <component>11</component>

     <file size="578560">C:\Users\tests\Virs\Adware.Look2me\Installer2.exe</file>

     <hash>fGeq6EB6ERXxzl70fJ19iJOISHNyPU9F</hash>

     <owner>tests-pc\tests:tests-pc\None</owner>

     <virus-info>Adware.Look2me.282</virus-info>

     <object>9edc4361-9f0c-22d0-6b86-edaeddfd9b05</object>

     <q-time>20190614115716149</q-time>

     <infection-type>5</infection-type>
   </item>
 </group-quarantine>

 <pages total="50" current="2" objects-per-page="2"/>
</drweb-es-api>

 

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

Элемент <group-quarantine /> содержит информацию об объектах, находящихся в Карантине на заданных станциях.

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

Атрибут

Описание

items

Общее количество объектов в Карантине на всех заданных станциях

period_from

Начало запрашиваемого периода, в течение которого объекты перемещались в Карантин

period_till

Конец запрашиваемого периода, в течение которого объекты перемещались в Карантин

Элемент <item /> содержит информацию о конкретном объекте Карантина.

Значение элемента <created-time /> — время добавления объекта в Карантин на Сервере.

Значение элемента <component /> — код компонента, переместившего объект в Карантин:

0 — неизвестный компонент,

1 — Сканер Dr.Web,

2 — SpIDer Guard,

3 — SpIDer Mail,

4 — SpIDer Gate,

5 — Менеджер карантина,

6 — Dr.Web для Kerio,

7 — Dr.Web для Microsoft Outlook,

8 — Dr.Web для IBM Lotus Domino,

9 — Dr.Web для Qbik WinGate,

10 — Dr.Web для ISA Server,

11 — Антируткит-модуль.

Элемент <file /> содержит информацию о конкретном файле, находящемся в Карантине.

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

Атрибут

Описание

size

Размер файла, находящегося в Карантине

Значение элемента <file /> — оригинальное имя файла и полный путь к файлу до перемещения в Карантин.

Значение элемента <hash /> — хеш-код объекта в формате SHA256.

Значение элемента <owner /> — имя пользователя-владельца файла.

Значение элемента <virus-info /> — название вредоносного объекта по классификации компании «Доктор Веб».

Значение элемента <object /> — идентификатор объекта после перемещения в Карантин.

Значение элемента <q-time /> — время добавления объекта в Карантин на станции.

Значение элемента <infection-type /> — тип инфекции:

1 — известная инфекция,

2 — известная модификация инфекции,

4 — неизвестная инфекция,

5 — рекламная программа,

6 — программа дозвона,

7 — программа-шутка,

8 — потенциально опасная программа,

9 — программа взлома.

Элемент <pages /> содержит информацию о постраничном отображении состояния Карантина.

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

Атрибут

Описание

total

Всего страниц с информацией о состоянии Карантина при постраничном выводе

current

Номер текущей страницы

objects-per-page

Количество объектов на странице

 

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

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

  "timestamp": 1560513463,

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

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

    "version": "12.00.0.201909260",
    "uuid": "76b05bc0-8691-11e9-63e5-7036cecd07fa"}},

"data": {
  "period_from": 1559314800,

  "period_till": 1560524399,

  "items": {
    "total": 100,

    "list": [
      {"component_code": 7,

        "created_time": 1560513439,

        "file": "C:\\Users\\tests\\Virs\\Win32.Parite.2\\postcard.gif.ex#",

        "file_size": 860362,

        "hash": "gOD2zZJlSOzAq5mwHe7LRRlFRO9ngUSd",

        "object": "8f7b2c47-8e9b-11e9-5812-dcfdccec8a94",

        "owner": "tests-pc\\tests:tests-pc\\None",

        "q_time": 20190614115718980,
        "virus_info": "IRC.Flood"},

      {"component_code": 11,
        "created_time": 1560513436,

        "file": "C:\\Users\\tests\\Virs\\Adware.Look2me\\Installer2.exe",

        "file_size": 578560,

        "hash": "fGeq6EB6ERXxzl70fJ19iJOISHNyPU9F",

        "object": "9edc4361-9f0c-22d0-6b86-edaeddfd9b05",

        "owner": "tests-pc\\tests:tests-pc\\None",

        "q_time": 20190614115716149,
        "virus_info": "Adware.Look2me.282"}]},

  "pages": {
    "current": 2,

    "objects_per_page": 2,
    "total": 50}}}

 

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

Блок data содержит общую информацию о запросе и блоки с информацией об объектах, находящихся в Карантине.

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

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

Описание

period_from

Начало запрашиваемого периода, в течение которого объекты перемещались в Карантин

period_till

Конец запрашиваемого периода, в течение которого объекты перемещались в Карантин

Блок items содержит информацию об объектах, находящихся в Карантине на заданных станциях.

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

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

Описание

total

Общее количество объектов в Карантине на всех заданных станциях

Массив list содержит информацию о конкретных объектах Карантина.

Элементы объектов в массиве list:

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

Описание

component_code

Код компонента, переместившего объект в Карантин:

0 — неизвестный компонент,

1 — Сканер Dr.Web,

2 — SpIDer Guard,

3 — SpIDer Mail,

4 — SpIDer Gate,

5 — Менеджер карантина,

6 — Dr.Web для Kerio,

7 — Dr.Web для Microsoft Outlook,

8 — Dr.Web для IBM Lotus Domino,

9 — Dr.Web для Qbik WinGate,

10 — Dr.Web для ISA Server,

11 — Антируткит-модуль.

created_time

Время добавления объекта в Карантин на Сервере

file

Оригинальное имя файла и полный путь к файлу до перемещения в Карантин

file_size

Размер файла, находящегося в Карантине

hash

Хеш-код объекта в формате SHA256

object

Идентификатор объекта после перемещения в Карантин

owner

Имя пользователя-владельца файла

q_time

Время добавления объекта в Карантин на станции

virus_info

Название вредоносного объекта по классификации компании «Доктор Веб»

Блок pages содержит информацию о количестве выводимых записей.

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

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

Описание

current

Номер текущей страницы

objects_per_page

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

total

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