|
Параметры запроса
Запрос не имеет параметров.
Пример запроса
https://192.168.1.1:9081/api/server/info.ds
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1587050194" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<server-info>
<host>192.168.1.1</host>
<uuid>b35d999d-9212-481d-af8c-8551c4113383</uuid>
<name>SRV Test</host>
<os>Linux</os>
<version>13.00.0.202005090</version>
<api-version>4.3.2</api-version>
<uptime>191400</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>824</free>
<used-by-server>14</used-by-server>
</memory>
<file-system>
<home-directory path="/opt/drwcs">
<total-space>28393443328</total-space>
<free-space>22584266752</free-space>
</home-directory>
<variable-directory path="/var/opt/drwcs">
<total-space>28393443328</total-space>
<free-space>22584266752</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>
<blocked>0</blocked>
<deinstalled>1</deinstalled>
<deleted>0</deleted>
<licensed>4294967295</licensed>
<new>2</new>
<newbies>0</newbies>
<offline>2</offline>
<online>1</online>
<total>3</total>
<unactivated>2</unactivated>
<with_update_errors>0</with_update_errors>
</stations>
</server-info>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <server-info /> содержит информацию о Сервере Dr.Web.
•Вложенные элементы элемента <server-info />:
Элемент
|
Описание
|
<host />
|
Доменное имя или IP-адрес Сервера Dr.Web
|
<uuid />
|
Идентификатор Сервера Dr.Web
|
<name>
|
Пользовательское название Сервера Dr.Web
|
<os />
|
Название операционной системы
|
<version />
|
Текущая версия Сервера Dr.Web
|
<api-version />
|
Текущая версия сборки Dr.Web Enterprise Security Suite
|
<uptime />
|
Время непрерывной работы
|
<platform />
|
Платформа
|
•Элемент <memory /> содержит информацию об объеме памяти Сервера Dr.Web.
▫Вложенные элементы элемента <memory />:
Элемент
|
Описание
|
<total />
|
Общий объем памяти в системе (в мегабайтах)
|
<free />
|
Объем свободной памяти (в мегабайтах)
|
<used-by-server />
|
Объем используемой Сервером Dr.Web памяти (в мегабайтах)
|
•Элемент <file-system /> содержит информацию о рабочем каталоге Сервера Dr.Web.
▫Элементы <home-directory /> и <variable-directory /> содержат информацию о доступном дисковом пространстве в рабочих подкаталогах.
Атрибут элементов <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 />
|
Количество станций, которые возможно зарегистрировать
|
<blocked />
|
Количество станций, допуск которых к Серверу Dr.Web заблокирован
|
<deinstalled />
|
Количество станций с удаленным антивирусным программным обеспечением
|
<deleted />
|
Количество удаленных станций
|
<licensed />
|
Максимальное количество станций, для которых активирована лицензия
|
<new />
|
Количество новых станций с неустановленным антивирусным программным обеспечением
|
<newbies />
|
Количество станций-новичков (запрашивающих доступ к Серверу Dr.Web)
|
<offline />
|
Количество станций не в сети
|
<online />
|
Количество станций в сети
|
<total />
|
Общее количество станций
|
<unactivated />
|
Количество неактивированных станций
|
<with_update_errors />
|
Количество станций с ошибками обновления антивирусного программного обеспечения
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1587050230,
"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": {
"host": "192.168.1.1",
"id": "b35d999d-9212-481d-af8c-8551c4113383",
"name": "SRV Test",
"os": "Linux",
"uptime": 191460,
"platform": "Linux 4.18.0-147.5.1.el8_1.x86_64 x86_64; glibc 2.28",
"version": "13.00.0.202005090",
"api_version": "4.3.2",
"memory": {
"free": 824,
"total": 3753,
"used_by_server": 14},
"file_system": {
"home_directory": {
"free_space": 22584172544,
"path": "/opt/drwcs",
"total_space": 28393443328},
"variable_directory": {
"free_space": 22584172544,
"path": "/var/opt/drwcs",
"total_space": 28393443328}},
"groups": {
"total": 143,
"customs": 1,
"systems": 142},
"stations": {
"activated": 1,
"available": 4294967292,
"blocked": 0,
"deinstalled": 1,
"deleted": 0,
"licensed": 4294967295,
"new": 2,
"newbies": 0,
"offline": 2,
"online": 1,
"total": 3,
"unactivated": 2,
"with_update_errors": 0}}}
|
Описание параметров ответного JSON
Блок data содержит общую информацию о Сервере Dr.Web.
Элементы блока data:
Название поля
|
Описание
|
host
|
Доменное имя или IP-адрес Сервера Dr.Web
|
id
|
Идентификатор Сервера Dr.Web
|
name
|
Пользовательское название Сервера Dr.Web
|
os
|
Название операционной системы
|
uptime
|
Время непрерывной работы
|
platform
|
Платформа
|
version
|
Текущая версия сборки Сервера Dr.Web
|
api_version
|
Текущая версия Web API
|
memory
|
Блок c информацией об объеме памяти Сервера Dr.Web
|
file-system
|
Блок c информацией о рабочем каталоге Сервера Dr.Web
|
groups
|
Блок c информацией о группах станций, зарегистрированных на данном Сервере Dr.Web
|
stations
|
Блок c информацией о станциях, зарегистрированных на данном Сервере Dr.Web
|
•Элементы блока memory:
Название поля
|
Описание
|
total
|
Общий объем памяти в системе (в мегабайтах)
|
free
|
Объем свободной памяти (в мегабайтах)
|
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
|
Количество станций, которые возможно зарегистрировать
|
blocked
|
Количество станций, допуск которых к Серверу Dr.Web заблокирован
|
deinstalled
|
Количество станций с удаленным антивирусным программным обеспечением
|
deleted
|
Количество удаленных станций
|
licensed
|
Максимальное количество станций, для которых активирована лицензия
|
new
|
Количество новых станций с неустановленным антивирусным программным обеспечением
|
newbies
|
Количество станций-новичков (запрашивающих доступ к Серверу Dr.Web)
|
offline
|
Количество станций не в сети
|
online
|
Количество станций в сети
|
total
|
Общее количество станций
|
unactivated
|
Количество неактивированных станций
|
with_update_errors
|
Количество станций с ошибками обновления антивирусного программного обеспечения
|
|