Получение списка групп

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

Параметр

Описание

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

parent-group

Идентификатор родительской группы.

В ответе возвращается информация по заданной группе о ее дочерних группах (без учета вложенных). Возможно получение списка подгрупп для системных групп Operating system, Status, Ungrouped.

Если параметр не задан, возвращается информация обо всех пользовательских группах уровня группы Everyone.

нет

 

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

https://192.168.1.1:9081/api/groups/list.ds

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

 

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

<drweb-es-api api_version="4.3.0" timestamp="1587998442" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
  <groups total="2">
     <group id="2c213cd2-eba1-4a0e-9f76-95e5e756d48c" name="Dr.Web Free" child_groups="0" stations="129" type="0"/>

     <group id="91644cc3-1dc1-42dc-a41e-5ea001f5538d" name="Dr.Web" child_groups="1" stations="110" type="0"/>
  </groups>
</drweb-es-api>

 

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

Элемент <groups /> содержит список групп, соответствующих запросу.

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

Атрибут

Описание

total

Общее количество групп в ответе

Элемент <group /> содержит параметры конкретной группы.

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

Атрибут

Описание

id

Идентификатор группы

name

Название группы

child-groups

Количество дочерних групп (без учета вложенных)

stations

Количество станций в группе

type

Тип группы:

0 — пользовательская группа,

1 — базовая группа и группа по умолчанию,

2 — группа, содержащая станции в сети (online),

3 — группа, содержащая станции не в сети (offline),

4 — группа, содержащая станции, сгруппированные по операционной системе,

5 — группа, содержащая станции, сгруппированные по сетевому протоколу,

6 — группа, содержащая станции с деинсталлированным Агентом Dr.Web,

7 — группа, содержащая станции с просроченным сроком допуска к Серверу Dr.Web,

10 — псевдогруппа,

13 — группа, содержащая Прокси-серверы Dr.Web для подключения Агентов и соседних Серверов Dr.Web.

 

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

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

    "timestamp": 1587999987,

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

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

          "version": "13.00.0.202005090",
          "uuid": "25cf53c0-885a-11ea-5c35-289def4dadcb"}},

 "data": {
    "groups": {
       "total": 2,

       "list": [
         {"child_groups": 0,

          "id": "2c213cd2-eba1-4a0e-9f76-95e5e756d48c",

          "name": "Dr.Web Free",

          "stations": 129,
          "type": 0},

         {"child_groups": 1,

          "id": "91644cc3-1dc1-42dc-a41e-5ea001f5538d",

          "name": "Dr.Web",

          "stations": 110,
          "type": 0}}]}}}

 

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

Блок groups содержит содержит список групп, соответствующих запросу.

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

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

Описание

total

Общее количество групп в ответе

list

Массив с параметрами для каждой группы

Каждый объект массива list содержит параметры конкретной группы.

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

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

Описание

child-groups

Количество дочерних групп (без учета вложенных)

id

Идентификатор группы

name

Название группы

stations

Количество станций в группе

type

Тип группы:

0 — пользовательская группа,

1 — базовая группа и группа по умолчанию,

2 — группа, содержащая станции в сети (online),

3 — группа, содержащая станции не в сети (offline),

4 — группа, содержащая станции, сгруппированные по операционной системе,

5 — группа, содержащая станции, сгруппированные по сетевому протоколу,

6 — группа, содержащая станции с деинсталлированным Агентом Dr.Web,

7 — группа, содержащая станции с просроченным сроком допуска к Серверу Dr.Web,

10 — псевдогруппа,

13 — группа, содержащая Прокси-серверы Dr.Web для подключения Агентов и соседних Серверов Dr.Web.