|
Параметры запроса
Параметр
|
Описание
|
Допустимые значения
|
Обязательный
|
components
|
Если параметр имеет значение yes, то в ответе будет приведена информация о компонентах группы.
По умолчанию no
|
yes | no
|
нет
|
id
|
Идентификатор группы.
Параметр может быть указан в запросе неограниченное количество раз для запроса информации о нескольких группах одновременно.
|
–
|
да
|
keys
|
Если параметр имеет значение yes, то в ответе будет приведена информация о лицензионных ключах группы.
По умолчанию no
|
yes | no
|
нет
|
rights
|
Если параметр имеет значение yes, то в ответе будет приведена информация о правах группы.
По умолчанию no
|
yes | no
|
нет
|
Пример запроса
http://192.168.1.1:9080/api/groups/info.ds?id=GroupForIGS&rights=yes&components=yes&keys=yes
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.0" timestamp="1559905015" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<groups total="1">
<group id="GroupForIGS" name="GroupForIGS" description="GroupForIGS" created="1489410582" modified="1489410582" parent_id="" parent_name="" type="0">
<keys inherited="true" inherited_group_id="20e27d73-d21d-b211-a788-85419c46f0e6" inherited_group_name="Everyone">
<key id="daa669be6fdbca01"/>
</keys>
<packages>
<package arch="all" os="windows" url="http://win10-1809-pro-x64-ru:9080/download/download.ds?os=windows&group-id=GroupForIGS"/>
</packages>
<rights inherited="true" inherited_group_id="20e27d73-d21d-b211-a788-85419c46f0e6" inherited_group_name="Everyone">
<right code="1" name="Run Dr.Web Scanner for Windows" value="1"/>
<!-- etc. Skipped in documentation -->
</rights>
<components inherited="true" inherited_group_id="20e27d73-d21d-b211-a788-85419c46f0e6" inherited_group_name="Everyone">
<component code="4" name="Dr.Web Scanner for Windows" status="1"/>
<component code="14" name="SpIDer Mail for Windows workstations" status="1"/>
<component code="38" name="SpIDer Gate for Windows workstations" status="1"/>
<component code="54" name="Dr.Web Office Control" status="1"/>
<component code="55" name="Dr.Web Antispam" status="1"/>
<component code="57" name="SpIDer Guard for Windows workstations" status="1"/>
<component code="58" name="SpIDer Guard for Windows servers" status="1"/>
<component code="103" name="Dr.Web plug-in for MS Outlook" status="1"/>
<component code="105" name="Dr.Web Firewall" status="1"/>
<component code="30" name="Dr.Web Agent for Windows" status="2"/>
<component code="37" name="Dr.Web Agent Scanner for Windows" status="2"/>
</components>
<child-groups>0</child-groups>
<stations>1</stations>
</group>
</groups>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <groups /> содержит информацию обо всех группах.
Атрибут элемента <groups />:
Атрибут
|
Описание
|
total
|
Общее количество групп
|
•Элемент <group /> содержит информацию о конкретной группе. Атрибуты элемента <group />:
Атрибут
|
Описание
|
id
|
Идентификатор группы
|
name
|
Название группы
|
description
|
Описание группы
|
created
|
Дата и время создания группы в формате Unix timestamp
|
modified
|
Дата и время модификации группы в формате Unix timestamp
|
parent_id
|
Идентификатор родительской группы. Если значение none, то родительская группа не задана.
|
parent_name
|
Название родительской группы. Если значение none, то родительская группа не задана.
|
type
|
Тип группы. Может принимать значения:
0 — пользовательская группа,
1 — базовая группа и группа по умолчанию,
2 — группа, содержащая станции в сети (online),
3 — группа, содержащая станции не в сети (offline),
4 — группа, содержащая станции, сгруппированные по операционной системе,
5 — группа, содержащая станции, сгруппированные по сетевому протоколу,
6 — группа, содержащая станции с деинсталлированным Агентом Dr.Web,
7 — группа, содержащая станции с просроченным сроком допуска к Серверу,
10 — псевдогруппа,
13 — группа, содержащая Прокси-серверы Dr.Web для подключения Агентов и соседних Серверов.
|
▫Элемент <keys /> содержит информацию обо всех лицензионных ключах группы. Атрибуты элемента <keys />:
Атрибут
|
Описание
|
inherited
|
Если принимает значение true, то ключи унаследованы от родительской группы, если false — параметры ключей заданы индивидуально.
|
inherited_group_id
|
Идентификатор родительской группы, от которой унаследованы параметры ключей. Если атрибут inherited принимает значение false, то значение данного атрибута будет none.
|
inherited_group_name
|
Название родительской группы, от которой унаследованы параметры ключей. Если атрибут inherited принимает значение false, то значение данного атрибута будет none.
|
▪Элемент <key /> содержит информацию о конкретном ключе. Атрибут элемента <key />:
Атрибут
|
Описание
|
id
|
Идентификатор ключа
|
▫Элемент <packages /> содержит ссылки на групповые установочные пакеты, созданные на данном Сервере, для различных архитектур и операционных систем. ▪Элемент <package /> содержит ссылку на конкретный установочный пакет. Атрибуты элемента <package />:
Атрибут
|
Описание
|
arch
|
Архитектура, на которую может быть установлен данный пакет:
•all — операционные системы любой разрядности, •x86 — 32-х разрядные операционные системы, •x86_64 — 64-х разрядные операционные системы |
os
|
Операционная система, на которую может быть установлен данный пакет
|
url
|
Адрес ресурса для скачивания пакета (Агента)
|
▫Элемент <rights /> содержит информацию обо всех правах группы. Атрибуты элемента <rights />:
Атрибут
|
Описание
|
inherited
|
Если принимает значение true, то права унаследованы от родительской группы, false — права заданы индивидуально.
|
inherited_group_id
|
Идентификатор родительской группы, от которой унаследованы права. Если атрибут inherited принимает значение false, то значение данного атрибута будет none.
|
inherited_group_name
|
Название родительской группы, от которой унаследованы права. Если атрибут inherited принимает значение false, то значение данного атрибута будет none.
|
▪Элемент <right /> содержит информацию о конкретном элементе прав. Атрибуты элемента <right />:
Атрибут
|
Описание
|
code
|
Числовой код элемента прав (см. в разделе Права)
|
name
|
Название элемента права (см. в разделе Права)
|
value
|
Значение элемента права:
0 — запрещено использование данного права,
1 — право предоставлено.
|
▫Элемент <components /> содержит информацию обо всех компонентах группы. Атрибуты элемента <components />:
Атрибут
|
Описание
|
inherited
|
Если принимает значение true, то компоненты унаследованы от родительской группы, если false — параметры компонентов заданы индивидуально.
|
inherited_group_id
|
Идентификатор родительской группы, от которой унаследованы параметры компонентов. Если атрибут inherited принимает значение false, то значение данного атрибута будет none.
|
inherited_group_name
|
Название родительской группы, от которой унаследованы параметры компонентов. Если атрибут inherited принимает значение false, то значение данного атрибута будет none.
|
▪Элемент <component /> содержит информацию о конкретном компоненте. Атрибуты элемента <component />:
Атрибут
|
Описание
|
code
|
Числовой код компонента (см. в разделе Коды компонентов)
|
name
|
Название компонента (см. в разделе Коды компонентов)
|
status
|
Статус компонента. Может принимать одно из следующих значений:
2 — компонент должен быть установлен,
1 — компонент может быть установлен,
0 — компонент не должен быть установлен.
|
▫Элемент <child-groups /> содержит количество дочерних групп для данной группы. ▫Элемент <stations /> содержит информацию обо всех станциях, входящих в данную группу. Значением данного элемента является количество станций, входящих в данную группу.
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1559905257,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "6c271cb0-8912-11e9-5a3b-b85a98f7c5ad"}},
"data": {
"groups": {
"total": 1,
"list": [
{"child_groups": 0,
"components": {
"inherited": true,
"inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6"},
"inherited_group_name": "Everyone",
"list": [
{"code": 4,
"name": "Dr.Web Scanner for Windows",
"status": 1},
{"code": 14,
"name": "SpIDer Mail for Windows workstations",
"status": 1},
{"code": 38,
"name": "SpIDer Gate for Windows workstations",
"status": 1},
{"code": 54,
"name": "Dr.Web Office Control",
"status": 1},
{"code": 55,
"name": "Dr.Web Antispam",
"status": 1},
{"code": 57,
"name": "SpIDer Guard for Windows workstations",
"status": 1},
{"code": 58,
"name": "SpIDer Guard for Windows servers",
"status": 1},
{"code": 103,
"name": "Dr.Web plug-in for MS Outlook",
"status": 1},
{"code": 105,
"name": "Dr.Web Firewall",
"status": 1},
{"code": 30,
"name": "Dr.Web Agent for Windows",
"status": 2},
{"code": 37,
"name": "Dr.Web Agent Scanner for Windows",
"status": 2}]},
"created_time": 1489410582,
"description": "GroupForIGS",
"has_personal_settings": true,
"id": "GroupForIGS",
"keys": {
"inherited": true,
"inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"inherited_group_name": "Everyone",
"list": [
"daa669be6fdbca01"]},
"modified_time": 1489410582,
"name": "GroupForIGS",
"packages": [
{"arch": "all",
"os": "windows",
"url": "http://win10-1809-pro-x64-ru:9080/download/download.ds?os=windows&group-id=GroupForIGS"}],
"permissions": {
"inherited": true,
"inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"inherited_group_name": "Everyone",
"list": [
{"name": "Run Dr.Web Scanner for Windows",
"right": 1,
"value": 1},
...]},
"stations": 1,
"type": 0}]}}}
|
Описание параметров ответного JSON
Блок groups содержит информацию обо всех запрошенных группах.
Элементы блока groups:
Название поля
|
Описание
|
total
|
Общее количество групп
|
•Массив list содержит информацию о конкретной группе. Элементы объектов в массиве list:
Название поля
|
Описание
|
child_groups
|
Количество дочерних групп для данной группы
|
created_time
|
Дата и время создания группы в формате Unix timestamp
|
description
|
Описание группы. Строка выводится, только если значение поля не пустое.
|
has_personal_settings
|
Если принимает значение true, то для группы или некоторых станций группы заданы персональные настройки, если false — персональные настройки не заданы.
|
id
|
Идентификатор группы
|
modified_time
|
Дата и время модификации группы в формате Unix timestamp
|
name
|
Название группы
|
parent_group_id
|
Идентификатор родительской группы. Если значение none, то родительская группа не задана. Строка выводится, только если значение поля не пустое.
|
parent_group_name
|
Название родительской группы. Если значение none, то родительская группа не задана. Строка выводится, только если значение поля не пустое.
|
stations
|
Количество станций в группе
|
type
|
Тип группы. Может принимать значения:
0 — пользовательская группа,
1 — базовая группа и группа по умолчанию,
2 — группа, содержащая станции в сети (online),
3 — группа, содержащая станции не в сети (offline),
4 — группа, содержащая станции, сгруппированные по операционной системе,
5 — группа, содержащая станции, сгруппированные по сетевому протоколу,
6 — группа, содержащая станции с деинсталлированным Агентом Dr.Web,
7 — группа, содержащая станции с просроченным сроком допуска к Серверу,
10 — псевдогруппа,
13 — группа, содержащая Прокси-серверы Dr.Web для подключения Агентов и соседних Серверов.
|
▫Блок components содержит информацию обо всех компонентах группы. ▪Массив list в блоке components содержит информацию о конкретном компоненте. Элементы объектов в массиве list:
Название поля
|
Описание
|
code
|
Числовой код компонента (см. в разделе Коды компонентов)
|
name
|
Название компонента (см. в разделе Коды компонентов)
|
status
|
Статус компонента. Может принимать одно из следующих значений:
2 — компонент должен быть установлен,
1 — компонент может быть установлен,
0 — компонент не должен быть установлен.
|
▫Блок keys содержит информацию обо всех лицензионных ключах группы. Элементы блока keys:
Название поля
|
Описание
|
inherited
|
Если принимает значение true, то ключи унаследованы от родительской группы, false — ключи заданы индивидуально.
|
inherited_group_id
|
Идентификатор родительской группы, от которой унаследованы параметры ключей. Если в поле inherited значение false, то в данном поле будет значение none.
|
inherited_group_name
|
Название родительской группы, от которой унаследованы параметры ключей. Если в поле inherited значение false, то в данном поле будет значение none.
|
▪Массив list в блоке keys содержит информацию о конкретном ключе. Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор ключа
|
▫Массив packages содержит ссылки на групповые установочные пакеты, созданные на данном Сервере, для различных архитектур и операционных систем. Элементы объектов в массиве packages:
Название поля
|
Описание
|
arch
|
Архитектура, на которую может быть установлен данный пакет:
•all — операционные системы любой разрядности, •x86 — 32-х разрядные операционные системы, •x86_64 — 64-х разрядные операционные системы |
os
|
Операционная система, на которую может быть установлен данный пакет
|
url
|
Адрес ресурса для скачивания пакета (Агента)
|
▫Блок permissions содержит информацию обо всех правах группы. Элементы блока permissions:
Название поля
|
Описание
|
inherited
|
Если принимает значение true, то права унаследованы от родительской группы, false — права заданы индивидуально.
|
inherited_group_id
|
Идентификатор родительской группы, от которой унаследованы права. Если в поле inherited значение false, то в данном поле будет значение none.
|
inherited_group_name
|
Название родительской группы, от которой унаследованы права. Если в поле inherited значение false, то в данном поле будет значение none.
|
▪Массив list в блоке permissions содержит информацию о конкретном элементе прав. Элементы объектов в массиве list:
Название поля
|
Описание
|
name
|
Название элемента права (см. в разделе Права)
|
right
|
Числовой код элемента прав (см. в разделе Права)
|
value
|
Значение элемента права:
0 — запрещено использование данного права,
1 — право предоставлено.
|
|