|
Параметры запроса
Запрос не имеет параметров.
Пример запроса
http://192.168.1.1:9080/api/server/info.ds
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.0" timestamp="1558521945" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<server-info>
<host>192.168.1.1</host>
<uuid>27671337-e0b0-4f60-aeb0-ab1f2ca47f77</uuid>
<os>Linux</os>
<version>12.00.0.201909260</version>
<api-version>4.3.0</api-version>
<uptime>60</uptime>
<platform>
<![CDATA[Linux 4.15.0-23-generic x86_64; Debian GNU/Linux buster/sid; glibc 2.27]]>
</platform>
<memory>
<total>3944</total>
<free>330</free>
<used-by-server>29</used-by-server>
</memory>
<file-system>
<home-directory path="/opt/drwcs">
<total-space>32392400896</total-space>
<free-space>20352274432</free-space>
</home-directory>
<variable-directory path="/var/opt/drwcs">
<total-space>32392400896</total-space>
<free-space>20352274432</free-space>
</variable-directory>
</file-system>
<groups total="231">
<custom>57</custom>
<system>174</system>
</groups>
<stations total="50">
<activated>1</activated>
<online>0</online>
<available>4294967245</available>
<licensed>4294967295</licensed>
<with_update_errors>0</with_update_errors>
<new>45</new>
<unactivated>45</unactivated>
<deinstalled>0</deinstalled>
<deleted>4</deleted>
<newbies>0</newbies>
<offline>46</offline>
</stations>
</server-info>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <server-info /> содержит информацию о Сервере.
•Вложенные элементы элемента <server-info />:
Элемент
|
Описание
|
<host />
|
Доменное имя или IP-адрес Сервера
|
<uuid />
|
Идентификатор Сервера
|
<os />
|
Операционная система
|
<version />
|
Текущая версия Сервера
|
<api-version />
|
Текущая версия сборки Dr.Web Web API для Enterprise Security Suite
|
<uptime />
|
Время непрерывной работы
|
<platform />
|
Платформа
|
•Элемент <memory /> содержит информацию об объеме памяти Сервера. Вложенные элементы элемента <memory />:
Элемент
|
Описание
|
<total />
|
Общий объем памяти в системе
|
<free />
|
Объем свободной памяти
|
<used-by-server />
|
Объем используемой Сервером памяти
|
•Элемент <file-system /> содержит информацию о рабочем каталоге Сервера. ▫Элементы <home-directory /> и <variable-directory /> содержат информацию о доступном дисковом пространстве в рабочих подкаталогах. Атрибут элементов <home-directory /> и <variable-directory />:
Атрибут
|
Описание
|
path
|
Путь к подкаталогу
|
Вложенные элементы элементов <home-directory /> и <variable-directory />:
Элемент
|
Описание
|
<total-space />
|
Общий объем дискового пространства (в мегабайтах)
|
<free-space />
|
Объем свободного пространства (в мегабайтах)
|
•Элемент <groups /> содержит информацию о группах станций, зарегистрированных на данном Сервере. Атрибут элемента <groups />:
Атрибут
|
Описание
|
total
|
Общее количество групп
|
Вложенные элементы элемента <groups />:
Элемент
|
Описание
|
<custom />
|
Пользовательские группы
|
<system />
|
Системные группы
|
•Элемент <stations /> содержит информацию о станциях, зарегистрированных на данном Сервере. Атрибут элемента <stations />:
Атрибут
|
Описание
|
total
|
Общее количество станций
|
Вложенные элементы элемента <stations />:
Элемент
|
Описание
|
<activated />
|
Количество активированных станций
|
<online />
|
Количество станций в сети
|
<available />
|
Количество станций, которые возможно зарегистрировать
|
<licensed />
|
Максимальное количество станций, для которых активирована лицензия
|
<with_update_errors />
|
Количество станций с ошибками обновления антивирусного ПО
|
<new />
|
Количество новых станций с неустановленным антивирусным ПО
|
<unactivated />
|
Количество неактивированных станций
|
<deinstalled />
|
Количество станций с удаленным антивирусным ПО
|
<deleted />
|
Количество удаленных станций
|
<newbies />
|
Количество станций-новичков (запрашивающих доступ к Серверу)
|
<offline />
|
Количество станций не в сети
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1558522033,
"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": {
"api_version": "4.3.0",
"file_system": {
"home_directory": {
"free_space": 20359036928,
"path": "/opt/drwcs",
"total_space": 32392400896},
"variable_directory": {
"free_space": 20359036928,
"path": "/var/opt/drwcs",
"total_space": 32392400896}},
"groups": {
"total": 231,
"customs": 57,
"systems": 174},
"host": "192.168.1.1",
"id": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77",
"memory": {
"free": 314,
"total": 3944,
"used_by_server": 29},
"os": "Linux",
"platform": "Linux 4.15.0-23-generic x86_64; Debian GNU/Linux buster/sid; glibc 2.27",
"stations": {
"activated": 1,
"available": 4294967245,
"deinstalled": 0,
"deleted": 4,
"licensed": 4294967295,
"new": 45,
"newbies": 0,
"offline": 46,
"online": 0,
"total": 50,
"unactivated": 45,
"with_update_errors": 0,
"uptime": 60,
"version": "12.00.0.201909260"}}}
|
Описание параметров ответного JSON
Блок data содержит общую информацию о Сервере.
Элементы блока data:
Название поля
|
Описание
|
api_version
|
Текущая версия сборки Dr.Web Web API для Enterprise Security Suite
|
host
|
Доменное имя или IP-адрес Сервера
|
id
|
Идентификатор Сервера
|
os
|
Операционная система
|
platform
|
Платформа
|
uptime
|
Время непрерывной работы
|
version
|
Текущая версия Сервера
|
•Блок file-system содержит информацию о рабочем каталоге Сервера. ▫Блоки home_directory и variable_directory содержат информацию о доступном дисковом пространстве в рабочих подкаталогах. Элементы блоков home_directory и variable_directory:
Название поля
|
Описание
|
free_space
|
Объем свободного пространства (в мегабайтах)
|
path
|
Путь к подкаталогу
|
total_space
|
Общий объем дискового пространства (в мегабайтах)
|
•Блок groups содержит информацию о группах станций, зарегистрированных на данном Сервере. Элементы блока groups:
Название поля
|
Описание
|
total
|
Общее количество групп
|
customs
|
Пользовательские группы
|
systems
|
Системные группы
|
•Блок memory содержит информацию об объеме памяти Сервера. Элементы блока memory:
Название поля
|
Описание
|
total
|
Общий объем памяти в системе
|
free
|
Объем свободной памяти
|
used_by_server
|
Объем используемой Сервером памяти
|
•Блок stations содержит информацию о станциях, зарегистрированных на данном Сервере. Элементы блока stations:
Название поля
|
Описание
|
activated
|
Количество активированных станций
|
available
|
Количество станций, которые возможно зарегистрировать
|
deinstalled
|
Количество станций с удаленным антивирусным ПО
|
deleted
|
Количество удаленных станций
|
licensed
|
Максимальное количество станций, для которых активирована лицензия
|
new
|
Количество новых станций с неустановленным антивирусным ПО
|
newbies
|
Количество станций-новичков (запрашивающих доступ к Серверу)
|
offline
|
Количество станций не в сети
|
online
|
Количество станций в сети
|
total
|
Общее количество станций
|
unactivated
|
Количество неактивированных станций
|
with_update_errors
|
Количество станций с ошибками обновления антивирусного ПО
|
|