|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
components
|
Если параметр имеет значение yes, то в ответе будет приведена информация о компонентах группы.
Допустимые значения: yes | no. По умолчанию: no.
|
нет
|
id
|
Идентификатор группы.
Параметр может быть указан в запросе неограниченное количество раз для запроса информации о нескольких группах одновременно.
|
да
|
keys
|
Если параметр имеет значение yes, то в ответе будет приведена информация о лицензионных ключах группы.
Допустимые значения: yes | no. По умолчанию: no.
|
нет
|
rights
|
Если параметр имеет значение yes, то в ответе будет приведена информация о правах группы.
Допустимые значения: yes | no. По умолчанию: no.
|
нет
|
Пример запроса
https://192.168.1.1:9081/api/groups/info.ds?id=20e27d73-d21d-b211-a788-85419c46f0e6&rights=yes&components=yes&keys=yes
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1589408311" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<groups total="1">
<group id="20e27d73-d21d-b211-a788-85419c46f0e6" name="Everyone" description="All stations" created="1585824539" modified="1589388246" parent_id="" parent_name="" parent_type="" type="1">
<keys inherited="false" inherited_group_id="" inherited_group_name="">
<key id="daa669be6fdbca01"/>
</keys>
<packages>
<package arch="all" os="windows" url="https://192.168.1.1:9081/download/download.ds?os=windows&group-id=20e27d73-d21d-b211-a788-85419c46f0e6"/>
</packages>
<rights inherited="false" inherited_group_id="" inherited_group_name="">
<right code="1" name="Run Dr.Web Scanner for Windows" value="1"/>
<!-- etc. Skipped in documentation -->
</rights>
<components inherited="false" inherited_group_id="" inherited_group_name="">
<component code="4" name="Dr.Web Scanner for Windows" status="1"/>
<!-- etc. Skipped in documentation -->
</components>
<child-groups>0</child-groups>
<stations>9</stations>
</group>
</groups>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <groups /> содержит информацию обо всех группах, соответствующих запросу.
Атрибут элемента <groups />:
Атрибут
|
Описание
|
total
|
Общее количество групп в ответе
|
•Элемент <group /> содержит параметры конкретной группы.
Атрибуты элемента <group />:
Атрибут
|
Описание
|
id
|
Идентификатор группы
|
name
|
Название группы
|
description
|
Описание группы
|
created
|
Дата и время создания группы
|
modified
|
Дата и время модификации группы
|
parent_id
|
Идентификатор родительской группы.
Если значение пустое, то родительская группа не задана.
|
parent_name
|
Название родительской группы.
Если значение пустое, то родительская группа не задана.
|
parent-type
|
Тип родительской группы (аналогично атрибуту type).
Если значение пустое, то родительская группа не задана.
|
type
|
Тип группы:
0 — пользовательская группа,
1 — базовая группа и группа по умолчанию,
2 — группа, содержащая станции в сети (online),
3 — группа, содержащая станции не в сети (offline),
4 — группа, содержащая станции, сгруппированные по операционной системе,
5 — группа, содержащая станции, сгруппированные по сетевому протоколу,
6 — группа, содержащая станции с деинсталлированным Агентом Dr.Web,
7 — группа, содержащая станции с просроченным сроком допуска к Серверу Dr.Web,
10 — псевдогруппа,
13 — группа, содержащая Прокси-серверы Dr.Web для подключения Агентов и соседних Серверов Dr.Web.
|
▫Элемент <keys /> содержит информацию обо всех лицензионных ключах группы.
Атрибуты элемента <keys />:
Атрибут
|
Описание
|
inherited
|
Если принимает значение true, то ключи унаследованы от родительской группы, если false — параметры ключей заданы индивидуально.
|
inherited_group_id
|
Идентификатор родительской группы, от которой унаследованы параметры ключей.
Если атрибут inherited принимает значение false, то значение данного атрибута будет пустым.
|
inherited_group_name
|
Название родительской группы, от которой унаследованы параметры ключей.
Если атрибут inherited принимает значение false, то значение данного атрибута будет пустым.
|
▪Элемент <key /> содержит информацию о конкретном ключе.
Атрибут элемента <key />:
Атрибут
|
Описание
|
id
|
Идентификатор ключа
|
▫Элемент <packages /> содержит ссылки на групповые установочные пакеты, созданные на данном Сервере Dr.Web, для различных архитектур процессора и операционных систем.
▪Элемент <package /> содержит ссылку на конкретный установочный пакет.
Атрибуты элемента <package />:
Атрибут
|
Описание
|
arch
|
Архитектура процессора, на которую может быть установлен данный пакет:
•all — операционные системы любой разрядности,
•x86 — 32-хразрядные операционные системы,
•x86_64 — 64-хразрядные операционные системы |
os
|
Операционная система, на которую может быть установлен данный пакет
|
url
|
Адрес ресурса для скачивания пакета (Агента Dr.Web)
|
▫Элемент <rights /> содержит информацию обо всех правах станций в группе.
Атрибуты элемента <rights />:
Атрибут
|
Описание
|
inherited
|
Если принимает значение true, то права унаследованы от родительской группы, false — права заданы индивидуально.
|
inherited_group_id
|
Идентификатор родительской группы, от которой унаследованы права.
Если атрибут inherited принимает значение false, то значение данного атрибута будет пустым.
|
inherited_group_name
|
Название родительской группы, от которой унаследованы права.
Если атрибут inherited принимает значение false, то значение данного атрибута будет пустым.
|
▪Элемент <right /> содержит информацию о конкретном праве станций в группе.
Атрибуты элемента <right />:
Атрибут
|
Описание
|
code
|
Числовой код права (см. Приложение А1. Коды прав станций)
|
name
|
Название права (см. Приложение А1. Коды прав станций)
|
value
|
Статус права:
0 — запрещено использование данного права,
1 — право предоставлено.
|
▫Элемент <components /> содержит информацию обо всех компонентах группы.
Атрибуты элемента <components />:
Атрибут
|
Описание
|
inherited
|
Если принимает значение true, то компоненты унаследованы от родительской группы, если false — параметры компонентов заданы индивидуально.
|
inherited_group_id
|
Идентификатор родительской группы, от которой унаследованы параметры компонентов.
Если атрибут inherited принимает значение false, то значение данного атрибута будет пустым.
|
inherited_group_name
|
Название родительской группы, от которой унаследованы параметры компонентов.
Если атрибут inherited принимает значение false, то значение данного атрибута будет пустым.
|
▪Элемент <component /> содержит информацию о конкретном компоненте.
Атрибуты элемента <component />:
Атрибут
|
Описание
|
code
|
Числовой код компонента (см. Приложение Б2. Коды компонентов)
|
name
|
Название компонента (см. Приложение Б2. Коды компонентов)
|
status
|
Статус компонента:
2 — компонент должен быть установлен,
1 — компонент может быть установлен,
0 — компонент не должен быть установлен.
|
▫Элемент <child-groups /> содержит количество дочерних групп для данной группы.
▫Элемент <stations /> содержит количество станций, входящих в данную группу.
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1589408381,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},
"data": {
"groups": {
"total": 1,
"list": [
{"child_groups": 0,
"components": {
"inherited": false,
"list": [
{"code": 4,
"name": "Dr.Web Scanner for Windows",
"status": 1},
...]},
"created_time": 1585824539,
"description": "All stations",
"has_personal_settings": true,
"id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"keys": {
"inherited": false,
"list": [
"daa669be6fdbca01"]},
"modified_time": 1589388246,
"name": "Everyone",
"packages": [
{"arch": "all",
"os": "windows",
"url": "https://192.168.1.1:9081/download/download.ds?os=windows&group-id=20e27d73-d21d-b211-a788-85419c46f0e6"}],
"permissions": {
"inherited": false,
"list": [
{"name": "Run Dr.Web Scanner for Windows",
"right": 1,
"value": 1},
...]},
"stations": 9,
"type": 1}]}}}
|
Описание параметров ответного JSON
Блок groups содержит информацию обо всех группах, соответствующих запросу.
Элементы блока groups:
Название поля
|
Описание
|
total
|
Общее количество групп в ответе
|
list
|
Массив с параметрами для каждой группы
|
•Каждый объект массива list содержит параметры конкретной группы.
Элементы объектов в массиве list:
Название поля
|
Описание
|
child_groups
|
Количество дочерних групп для данной группы
|
components
|
Блок с информацией обо всех компонентах группы
|
created_time
|
Дата и время создания группы
|
description
|
Описание группы. Строка выводится, только если значение поля не пустое.
|
has_personal_settings
|
Если принимает значение true, то для группы или некоторых станций группы заданы персональные настройки, если false — персональные настройки не заданы.
|
id
|
Идентификатор группы
|
keys
|
Блок с информацией обо всех лицензионных ключах группы
|
modified_time
|
Дата и время модификации группы
|
name
|
Название группы
|
packages
|
Массив ссылок на групповые установочные пакеты, созданные на данном Сервере Dr.Web, для различных архитектур процессора и операционных систем
|
parent_group_id
|
Идентификатор родительской группы.
Если значение none, то родительская группа не задана. Строка выводится, только если значение поля не пустое.
|
parent_group_name
|
Название родительской группы.
Если значение none, то родительская группа не задана. Строка выводится, только если значение поля не пустое.
|
parent_group_type
|
Тип родительской группы.
Если значение none, то родительская группа не задана. Строка выводится, только если значение поля не пустое.
|
permissions
|
Блок с информацией обо всех правах станций в группе
|
stations
|
Количество станций в группе
|
type
|
Тип группы:
0 — пользовательская группа,
1 — базовая группа и группа по умолчанию,
2 — группа, содержащая станции в сети (online),
3 — группа, содержащая станции не в сети (offline),
4 — группа, содержащая станции, сгруппированные по операционной системе,
5 — группа, содержащая станции, сгруппированные по сетевому протоколу,
6 — группа, содержащая станции с деинсталлированным Агентом Dr.Web,
7 — группа, содержащая станции с просроченным сроком допуска к Серверу Dr.Web,
10 — псевдогруппа,
13 — группа, содержащая Прокси-серверы Dr.Web для подключения Агентов и соседних Серверов Dr.Web.
|
▫Элементы блока components:
Название поля
|
Описание
|
inherited
|
Если принимает значение true, то компоненты унаследованы от родительской группы, если false — параметры компонентов заданы индивидуально.
|
inherited_group_id
|
Идентификатор родительской группы, от которой унаследованы параметры компонентов.
Данный элемент будет отсутствовать, если элемент inherited принимает значение false.
|
inherited_group_name
|
Название родительской группы, от которой унаследованы параметры компонентов.
Данный элемент будет отсутствовать, если элемент inherited принимает значение false.
|
list
|
Массив с параметрами для каждого компонента группы
|
•Каждый объект массива list содержит параметры конкретного компонента группы.
Элементы объектов в массиве list:
Название поля
|
Описание
|
code
|
Числовой код компонента (см. Приложение Б2. Коды компонентов)
|
name
|
Название компонента (см. Приложение Б2. Коды компонентов)
|
status
|
Статус компонента:
2 — компонент должен быть установлен,
1 — компонент может быть установлен,
0 — компонент не должен быть установлен.
|
▫Блок keys содержит информацию обо всех лицензионных ключах группы.
Элементы блока keys:
Название поля
|
Описание
|
inherited
|
Если принимает значение true, то ключи унаследованы от родительской группы, false — ключи заданы индивидуально.
|
inherited_group_id
|
Идентификатор родительской группы, от которой унаследованы параметры ключей.
Данный элемент будет отсутствовать, если элемент inherited принимает значение false.
|
inherited_group_name
|
Название родительской группы, от которой унаследованы параметры ключей.
Данный элемент будет отсутствовать, если элемент inherited принимает значение false.
|
list
|
Массив с информацией обо всех ключах группы
|
▪Каждый объект массива list содержит информацию о конкретном ключе.
Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор ключа
|
▫Каждый объект массива packages содержит ссылку на конкретный групповой установочный пакет.
Элементы объектов в массиве packages:
Название поля
|
Описание
|
arch
|
Архитектура процессора, на которую может быть установлен данный пакет:
•all — операционные системы любой разрядности,
•x86 — 32-хразрядные операционные системы,
•x86_64 — 64-хразрядные операционные системы |
os
|
Операционная система, на которую может быть установлен данный пакет
|
url
|
Адрес ресурса для скачивания пакета (Агента Dr.Web)
|
▫Блок permissions содержит информацию обо всех правах станций в группе.
Элементы блока permissions:
Название поля
|
Описание
|
inherited
|
Если принимает значение true, то права унаследованы от родительской группы, false — права заданы индивидуально.
|
inherited_group_id
|
Идентификатор родительской группы, от которой унаследованы права.
Данный элемент будет отсутствовать, если элемент inherited принимает значение false.
|
inherited_group_name
|
Название родительской группы, от которой унаследованы права.
Данный элемент будет отсутствовать, если элемент inherited принимает значение false.
|
list
|
Массив с информацией для каждого права станций в группе
|
▪Каждый объект массива list содержит информацию о конкретном праве станций в группе.
Элементы объектов в массиве list:
Название поля
|
Описание
|
name
|
Название права (см. Приложение А1. Коды прав станций)
|
right
|
Числовой код права (см. Приложение А1. Коды прав станций)
|
value
|
Статус права:
0 — запрещено использование данного права,
1 — право предоставлено.
|
|