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

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

Параметр

Описание

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

parent-group

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

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

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

нет

 

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

http://192.168.1.1:9080/api/groups/list.ds?parent-group=ParentGroupForLGS

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

 

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

<drweb-es-api api_version="4.3.0" timestamp="1558521889" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <groups total="2">
     <group id="98c8f98a-16e9-4fb5-af4d-d62923dca7b3" name="Новая группа2" child_groups="0" stations="0" type="0"/>

     <group id="3" name="Новая группа3" child_groups="2" stations="1" 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 — группа, содержащая станции с просроченным сроком допуска к Серверу,

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

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

 

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

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

    "timestamp": 1558521971,

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

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

 "version": "12.00.0.201909260",
 "uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},

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

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

    "id": "98c8f98a-16e9-4fb5-af4d-d62923dca7b3",

    "name": "Новая группа2",

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

{"child_groups": 2,

 "id": "3",

 "name": "Новая группа3",

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

 

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

Блок groups содержит информацию обо всех запрошенных группах.

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

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

Описание

total

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

Массив list содержит информацию о конкретной группе.

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

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

Описание

child-groups

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

id

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

name

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

stations

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

type

Тип группы. Может принимать значения:

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

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

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

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

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

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

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

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

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

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