|
Параметры запроса
Запрос не имеет параметров.
Пример запроса
https://192.168.1.1:9081/api/server/summary.ds
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1587165763" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<server-summary>
<host>192.168.1.1</host>
<uuid>b35d999d-9212-481d-af8c-8551c4113383</uuid>
<os>Linux</os>
<version>13.00.1.202310121</version>
<api_version>4.3.2</api_version>
<uptime>306961</uptime>
<platform>
<![CDATA[Linux 4.18.0-147.5.1.el8_1.x86_64 x86_64; glibc 2.28]]>
</platform>
<memory>
<total>3753</total>
<free>2000</free>
<used-by-server>17</used-by-server>
</memory>
<file-system>
<home-directory path="/opt/drwcs">
<total-space>28393443328</total-space>
<free-space>17384546304</free-space>
</home-directory>
<variable-directory path="/var/opt/drwcs">
<total-space>28393443328</total-space>
<free-space>17384546304</free-space>
</variable-directory>
</file-system>
<groups total="143">
<custom>1</custom>
<system>142</system>
</groups>
<stations total="3">
<activated>1</activated>
<available>4294967292</available>
<deinstalled>1</deinstalled>
<expired>0</expired>
<licensed>4294967295</licensed>
<new>2</new>
<newbies>0</newbies>
<offline>3</offline>
<online>0</online>
<unactivated>2</unactivated>
<with_update_errors>0</with_update_errors>
</stations>
<keys>
<key id="daa669be6fdbca01" user="Dr.Web" expires="1612078293">
</keys>
<repository>
<product code="05-drwmeta" name="Dr.Web Meta information" modified_time="1586995200" revision="13020200416000000" size="279704" files="14" state="normal" last_update_endtime="1587129960" last_update_src="Launched by Task Scheduler" last_update_rc="Requested product not found on GUS servers" last_update_rc_code="106"/>
<!-- etc. Skipped in documentation -->
<product code="80-drwnews" name="Doctor Web News" modified_time="1587092725"" revision="13020200417030525" size="21958741" files="1622" state="normal" last_update_endtime="1587131081" last_update_src="Launched from the Control Center" last_update_rc="Update completed successfully" last_update_rc_code="2"/>
</repository>
</server-summary>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <server-summary /> содержит информацию о Сервере Dr.Web.
•Вложенные элементы элемента <server-summary />:
Элемент
|
Описание
|
<host />
|
Доменное имя или IP-адрес Сервера Dr.Web
|
<uuid />
|
Идентификатор Сервера Dr.Web
|
<os />
|
Операционная система
|
<version />
|
Текущая версия сборки Сервера Dr.Web
|
<api_version />
|
Текущая версия Web API
|
<uptime />
|
Время непрерывной работы
|
<platform />
|
Платформа
|
•Элемент <memory /> содержит информацию об объеме памяти Сервера Dr.Web.
▫Вложенные элементы элемента <memory />:
Элемент
|
Описание
|
<total />
|
Общий объем памяти в системе (в мегабайтах)
|
<free />
|
Объем свободной памяти (в мегабайтах)
|
<used-by-server />
|
Объем используемой Сервером Dr.Web памяти (в мегабайтах)
|
•Элемент <file-system /> содержит информацию о рабочем каталоге Сервера Dr.Web.
▫Вложенные элементы <home-directory /> и <variable-directory /> элемента <file-system /> содержат информацию о доступном дисковом пространстве в рабочих подкаталогах.
Атрибут элементов <home-directory /> и <variable-directory />:
Атрибут
|
Описание
|
path
|
Путь к подкаталогу
|
▪Вложенные элементы элементов <home-directory /> и <variable-directory />:
Элемент
|
Описание
|
<total-space />
|
Общий объем дискового пространства (в мегабайтах)
|
<free-space />
|
Объем свободного пространства (в мегабайтах)
|
•Элемент <groups /> содержит информацию о группах станций, зарегистрированных на данном Сервере Dr.Web.
Атрибут элемента <groups />:
Атрибут
|
Описание
|
total
|
Общее количество групп
|
▫Вложенные элементы элемента <groups />:
Элемент
|
Описание
|
<custom />
|
Пользовательские группы
|
<system />
|
Системные группы
|
•Элемент <stations /> содержит информацию о станциях, зарегистрированных на данном Сервере Dr.Web.
Атрибут элемента <stations />:
Атрибут
|
Описание
|
total
|
Общее количество станций
|
▫Вложенные элементы элемента <stations />:
Элемент
|
Описание
|
<activated />
|
Количество активированных станций
|
<available />
|
Количество станций, которые возможно зарегистрировать
|
<deinstalled />
|
Количество станций с удаленным антивирусным программным обеспечением
|
<deleted />
|
Количество удаленных станций
|
<licensed />
|
Максимальное количество станций, для которых активирована лицензия
|
<new />
|
Количество новых станций с неустановленным антивирусным программным обеспечением
|
<newbies />
|
Количество станций-новичков (запрашивающих доступ к Серверу Dr.Web)
|
<offline />
|
Количество станций не в сети
|
<online />
|
Количество станций в сети
|
<unactivated />
|
Количество неактивированных станций
|
<with_update_errors />
|
Количество станций с ошибками обновления антивирусного программного обеспечения
|
•Элемент <keys /> содержит информацию о лицензионных ключах на данном Сервере Dr.Web.
▫Вложенный элемент <key /> элемента <keys /> содержит информацию о конкретном лицензионном ключе.
Атрибуты элемента <key />:
Атрибут
|
Описание
|
id
|
Идентификатор ключа
|
user
|
Идентификатор пользователя
|
expires
|
Дата истечения действия лицензии
|
•Элемент <repository /> содержит информацию о продуктах в репозитории.
▫Вложенные элементы <product /> содержат информацию о конкретном продукте в репозитории.
Атрибуты элемента <product />:
Атрибут
|
Описание
|
code
|
Код продукта
|
name
|
Название продукта
|
modified_time
|
Дата последнего обновления
|
revision
|
Номер ревизии
|
size
|
Размер ревизии (в байтах)
|
files
|
Количество файлов в ревизии
|
state
|
Состояние обновления продукта:
•normal — продукт успешно обновляется,
•frozen — продукт заморожен,
•disabled — обновление продукта отключено. |
last_update_endtime
|
Время завершения последнего обновления
|
last_update_src
|
Инициатор обновления
|
last_update_rc
|
Результат обновления (см. Приложение Д. Возвращаемые коды обновления)
|
last_update_rc_code
|
Код результата обновления (см. Приложение Д. Возвращаемые коды обновления)
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1587165759,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},
"data": {
"host": "192.168.1.1",
"id": "b35d999d-9212-481d-af8c-8551c4113383",
"os": "Linux",
"uptime": 306961,
"platform": "Linux 4.18.0-147.5.1.el8_1.x86_64 x86_64; glibc 2.28",
"version": "13.00.1.202310121",
"api_version": "4.3.2",
"memory": {
"free": 2001,
"total": 3753,
"used_by_server": 17},
"file_system": {
"home_directory": {
"free_space": 17384656896,
"path": "/opt/drwcs",
"total_space": 28393443328},
"var_dir": {
"free_space": 17384656896,
"path": "/var/opt/drwcs",
"total_space": 28393443328}},
"groups": {
"total": 143,
"customs": 1,
"systems": 142},
"stations": {
"activated": 1,
"available": 4294967292,
"deinstalled": 1,
"deleted": 0,
"licensed": 4294967295,
"new": 2,
"newbies": 0,
"offline": 3,
"online": 0,
"total": 3,
"unactivated": 2,
"with_update_errors": 0},
"keys": [{
"expires": 1612078293,
"id": "daa669be6fdbca01",
"user_name": "Dr.Web"}],
"repository": {
"products": {
"05-drwmeta": {
"files": 14,
"last_update_endtime": 1587129960,
"last_update_rc": "Requested product not found on GUS servers",
"last_update_rc_code": "106",
"last_update_src": "Launched by Task Scheduler",
"modified_time": 1586995200,
"name": "Dr.Web Meta information",
"revision": "13020200416000000",
"size": 279704,
"state": "normal"},
...,
"80-drwnews": {
"files": 1622,
"last_update_endtime": 1587131081,
"last_update_rc": "Update completed successfully",
"last_update_rc_code": "2",
"last_update_src": "Launched by Task Scheduler",
"modified_time": 1587092725,
"name": "Doctor Web News",
"revision": "13020200417030525",
"size": 21958741,
"state": "normal"}}}}}
|
Описание параметров ответного JSON
Блок data содержит информацию о Сервере Dr.Web.
Элементы блока data:
Название поля
|
Описание
|
host
|
Доменное имя или IP-адрес Сервера Dr.Web
|
id
|
Идентификатор Сервера Dr.Web
|
os
|
Операционная система
|
uptime
|
Время непрерывной работы
|
platform
|
Платформа
|
version
|
Текущая версия сборки Сервера Dr.Web
|
api_version
|
Текущая версия Web API
|
memory
|
Блок с информацией об объеме памяти Сервера Dr.Web
|
file_system
|
Блок с информацией о рабочем каталоге Сервера Dr.Web
|
groups
|
Блок с информацией о группах станций, зарегистрированных на данном Сервере Dr.Web
|
stations
|
Блок с информацией о станциях, зарегистрированных на данном Сервере Dr.Web
|
keys
|
Блок с информацией обо всех лицензионных ключах, используемых данным Сервером Dr.Web
|
repository
|
Блок с информацией о продуктах в репозитории
|
•Элементы блока memory:
Название поля
|
Описание
|
free
|
Объем свободной памяти (в мегабайтах)
|
total
|
Общий объем памяти в системе (в мегабайтах)
|
used_by_server
|
Объем используемой Сервером Dr.Web памяти (в мегабайтах)
|
•Блок file_system состоит из вложенных блоков.
▫Вложенные блоки home_directory и variable_directory содержат информацию о доступном дисковом пространстве в рабочих подкаталогах.
Элементы блоков home_directory и variable_directory:
Название поля
|
Описание
|
free_space
|
Объем свободного пространства (в мегабайтах)
|
path
|
Путь к подкаталогу
|
total_space
|
Общий объем дискового пространства (в мегабайтах)
|
•Элементы блока groups:
Название поля
|
Описание
|
total
|
Общее количество групп
|
customs
|
Пользовательские группы
|
systems
|
Системные группы
|
•Элементы блока stations:
Название поля
|
Описание
|
activated
|
Количество активированных станций
|
available
|
Количество станций, которые возможно зарегистрировать
|
deinstalled
|
Количество станций с удаленным антивирусным программным обеспечением
|
deleted
|
Количество удаленных станций
|
licensed
|
Максимальное количество станций, для которых активирована лицензия
|
new
|
Количество новых станций с неустановленным антивирусным программным обеспечением
|
newbies
|
Количество станций-новичков (запрашивающих доступ к Серверу Dr.Web)
|
offline
|
Количество станций не в сети
|
online
|
Количество станций в сети
|
total
|
Общее количество станций
|
unactivated
|
Количество неактивированных станций
|
with_update_errors
|
Количество станций с ошибками обновления антивирусного программного обеспечения
|
•Каждый объект массива keys содержит информацию о конкретном лицензионном ключе.
Элементы массива keys:
Название поля
|
Описание
|
expires
|
Дата истечения действия лицензии
|
id
|
Идентификатор ключа
|
user_name
|
Идентификатор пользователя
|
•Элемент products блока repository состоит из вложенных блоков.
▫Каждый вложенный блок содержит параметры конкретного продукта. Название вложенного блока соответствует коду продукта в репозитории.
Элементы вложенных блоков элемента products:
Название поля
|
Описание
|
files
|
Количество файлов в ревизии
|
last_update_endtime
|
Время завершения последнего обновления
|
last_update_src
|
Инициатор обновления
|
last_update_rc
|
Результат обновления (см. Приложение Д. Возвращаемые коды обновления)
|
last_update_rc_code
|
Код результата обновления (см. Приложение Д. Возвращаемые коды обновления)
|
modified_time
|
Дата последнего обновления
|
name
|
Название продукта
|
revision
|
Номер ревизии
|
size
|
Размер ревизии (в байтах)
|
state
|
Состояние обновления продукта:
•normal — продукт успешно обновляется,
•frozen — продукт заморожен,
•disabled — обновление продукта отключено. |
|