Получение статистики Сервера по сканированию

Параметры запроса

Запрос не имеет параметров.

 

Пример запроса

http://192.168.1.1:9080/api/server/summary.ds

Ниже представлены примеры ответов в формате XML и в формате JSON.

 

Ответ в формате XML

<drweb-es-api api_version="4.3.0" timestamp="1558521947" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <server-summary>
    <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>328</free>
        <used-by-server>29</used-by-server>
    </memory>

    <file-system>
        <home-directory path="/opt/drwcs">
          <total-space>32392400896</total-space>
          <free-space>20352233472</free-space>
        </home-directory>

        <variable-directory path="/var/opt/drwcs">
          <total-space>32392400896</total-space>
          <free-space>20352233472</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>

    <keys>
        <key id="daa669be6fdbca01" user="Dr.Web" expires="1576492266">
    </keys>

    <repository>
        <product code="20-drwagent" name="Dr.Web Agent for Windows" modified_time="1558694129" revision="12020190524103529" size="98140163" files="376" state="normal"/>

        <product code="10-drwspamdb" name="AntiSpam Bases" modified_time="1559032659" revision="12020190528083739" size="2790558" files="17" state="normal"/>

        <product code="10-drwbases" name="Dr.Web Virus Bases" modified_time="1559031502" revision="12020190528081822" size="176280787" files="257" state="normal"/>

        <product code="20-drwunix" name="Dr.Web Agent for UNIX" modified_time="1020211200" revision="10020020501000000" size="0" files="0" state="normal"/>

        <product code="10-drwgatedb" name="SpIDer Gate Bases" modified_time="1559034443" revision="12020190528090723" size="248129729" files="119" state="normal"/>

        <product code="10-drwupgrade" name="Dr.Web Updater" modified_time="1559001600" revision="12020190528000000" size="24099022" files="17" state="normal"/>

        <product code="80-drwnews" name="Doctor Web News" modified_time="1559001600" revision="12020190528000000" size="23461777" files="1929" state="normal"/>

        <product code="20-drwcs" name="Dr.Web Server" modified_time="1559001600" revision="12020190528000000" size="402800242" files="1992" state="normal"/>

        <product code="70-drwutils" name="Dr.Web administrative utilities" modified_time="1020211200" revision="10020020501000000" size="13340" files="1" state="disabled"/>

        <product code="70-drwextra" name="Dr.Web Enterprise products" modified_time="1020211200" revision="10020020501000000" size="31215" files="2" state="disabled"/>

        <product code="15-drwappcntrl" name="Application Control Bases" modified_time="1020211200" revision="10020020501000000" size="11596" files="6" state="disabled"/>

        <product code="05-drwmeta" name="Dr.Web Meta information" modified_time="1559001600" revision="12020190528000000" size="256131" files="7" state="normal"/>

        <product code="40-drwproxy" name="Dr.Web Proxy Server" modified_time="1020211200" revision="10020020501000000" size="0" files="0" state="normal"/>

        <product code="20-drwandroid11" name="Dr.Web Agent for Android" modified_time="1020211200" revision="10020020501000000" size="0" files="0" state="normal"/>
    </repository>
  </server-summary>
</drweb-es-api>

 

Описание параметров ответного XML

Элемент <server-summary /> содержит информацию о Сервере.

Вложенные элементы элемента <server-summary />:

Элемент

Описание

<host />

Доменное имя или IP-адрес Сервера

<uuid />

Идентификатор Сервера

<os />

Операционная система

<uptime />

Время непрерывной работы

<platform />

Платформа

<version />

Текущая версия Сервера

<api_version />

Текущая версия сборки Dr.Web Web API для Enterprise Security Suite

•Элемент <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 />

Количество станций не в сети

•Элемент <keys /> содержит информацию о лицензионных ключах на данном Сервере.

▫Элемент <key /> элемента <keys /> содержит информацию о конкретном лицензионном ключе.

Атрибуты элемента <key />:

Атрибут

Описание

id

Идентификатор ключа

user

Идентификатор пользователя

expires

Дата истечения действия лицензии

•Элемент <repository /> содержит информацию о продуктах в репозитории. Элементы <product /> содержат информацию о конкретном продукте в репозитории.

Атрибуты элемента <product />:

Атрибут

Описание

code

Код продукта

name

Название продукта

modified_time

Дата последнего обновления (в формате Unix timestamp)

revision

Номер ревизии

size

Размер ревизии в байтах

files

Количество файлов в ревизии

state

Состояние обновления продукта. Может принимать следующие значения:

•normal — продукт успешно обновляется,

•frozen — продукта заморожен,

•disabled — обновление продукта отключено.

 

Ответ в формате JSON

{ "head": {
    "status": true,

    "timestamp": 1558522035,

    "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",

    "host": "192.168.1.1",

    "id": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77",

    "file_system": {
      "home_directory": {
          "free_space": 20358995968,

          "path": "/opt/drwcs",
          "total_space": 32392400896},

      "var_dir": {
          "free_space": 20358995968,

          "path": "/var/opt/drwcs",
          "total_space": 32392400896}},

    "groups": {
      "customs": 57,
      "systems": 174,
      "total": 231},

    "keys": [{
      "expires": 1576492266,

      "id": "daa669be6fdbca01",
      "user_name": "Dr.Web"}],

    "memory": {
      "total": 311,

      "free": 3944,
       "used_by_server": 29},

    "os": "Linux",

    "platform": "Linux 4.15.0-23-generic x86_64; Debian GNU/Linux buster/sid; glibc 2.27",

    "repository": {
      "products": {
          "05-drwmeta": {
            "files": 7,

            "modified_time": 1557878400,

            "name": "Dr.Web Meta information",

            "revision": "12020190515000000",

            "size": 256131,
            "state": "normal"},

          "10-drwbases": {
            "files": 257,

            "modified_time": 1557947246,

            "name": "Dr.Web Virus Bases",

            "revision": "12020190515190726",

            "size": 177296553,
            "state": "normal"},

          "10-drwgatedb": {
            "files": 119,

            "modified_time": 1557947551,

            "name": "SpIDer Gate Bases",

            "revision": "12020190515191231",

            "size": 247281865,
            "state": "normal"},

          "10-drwspamdb": {
            "files": 17,

            "modified_time": 1557909561,

            "name": "AntiSpam Bases",

            "revision": "12020190515083921",

            "size": 2874094,
            "state": "normal"},

          "10-drwupgrade": {
            "files": 17,

            "modified_time": 1557878400,

            "name": "Dr.Web Updater",

            "revision": "12020190515000000",

            "size": 24131358,
            "state": "normal"},

          "15-drwappcntrl": {
            "files": 6,

            "modified_time": 1020211200,

            "name": "Application Control Bases",

            "revision": "10020020501000000",

            "size": 11596,
            "state": "disabled"},

          "20-drwagent": {
            "files": 376,

            "modified_time": 1557860828,

            "name": "Dr.Web Agent for Windows",

            "revision": "12020190514190708",

            "size": 98154454,
            "state": "normal"},

          "20-drwandroid11": {
            "files": 0,

            "modified_time": 1020211200,

            "name": "Dr.Web Agent for Android",

            "revision": "10020020501000000",

            "size": 0,
            "state": "normal"},

          "20-drwcs": {
            "files": 1991,

            "modified_time": 1557878400,

            "name": "Dr.Web Server",

            "revision": "12020190515000000",

            "size": 401346488,
            "state": "normal"},

          "20-drwunix": {
            "files": 0,

            "modified_time": 1020211200,

            "name": "Dr.Web Agent for UNIX",

            "revision": "10020020501000000",

            "size": 0,
            "state": "normal"},

          "40-drwproxy": {
            "files": 0,

            "modified_time": 1020211200,

            "name": "Dr.Web Proxy Server",

            "revision": "10020020501000000",

            "size": 0,
            "state": "normal"},

          "70-drwextra": {
            "files": 2,

            "modified_time": 1020211200,

            "name": "Dr.Web Enterprise products",

            "revision": "10020020501000000",

            "size": 31175,
            "state": "disabled"},

          "70-drwutils": {
            "files": 1,

            "modified_time": 1020211200,

            "name": "Dr.Web administrative utilities",

            "revision": "10020020501000000",

            "size": 13340,
          "state": "disabled"},

          "80-drwnews": {
            "files": 1924,

            "modified_time": 1557878400,

            "name": "Doctor Web News",

            "revision": "12020190515000000",

            "size": 23583584,
            "state": "normal"}}},

    "stations": {
      "activated": 1,

      "available": 4294967245,

      "deinstalled": 0,

      "deleted": 4,

      "licensed": 4294967245,

      "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:

Название поля

Описание

customs

Пользовательские группы

systems

Системные группы

total

Общее количество групп

•Блок keys содержит информацию обо всех лицензионных ключах, используемых данным Сервером.

Элементы блока keys:

Название поля

Описание

expires

Дата истечения действия лицензии

id

Идентификатор ключа

user_name

Идентификатор пользователя

•Блок memory содержит информацию об объеме памяти Сервера.

Элементы блока memory:

Название поля

Описание

free

Объем свободной памяти

total

Общий объем памяти в системе

used_by_server

Объем используемой Сервером памяти

•Блок repository содержит информацию о продуктах в репозитории.

▫Блоки products содержат информацию о конкретных продуктах в репозитории, названия вложенных блоков соответствуют кодам продуктов.

Элементы блока products:

Название поля

Описание

files

Количество файлов в ревизии

modified_time

Дата последнего обновления (в формате Unix timestamp)

name

Название продукта

revision

Номер ревизии

size

Размер ревизии в байтах

state

Состояние обновления продукта. Может принимать следующие значения:

•normal — продукт успешно обновляется,

•frozen — продукта заморожен,

•disabled — обновление продукта отключено.

•Блок stations содержит информацию о станциях, зарегистрированных на данном Сервере.

Элементы блока stations:

Название поля

Описание

activated

Количество активированных станций

available

Количество станций, которые возможно зарегистрировать

deinstalled

Количество станций с удаленным антивирусным ПО

deleted

Количество удаленных станций

licensed

Максимальное количество станций, для которых активирована лицензия

new

Количество новых станций с неустановленным антивирусным ПО

newbies

Количество станций-новичков (запрашивающих доступ к Серверу)

offline

Количество станций не в сети

online

Количество станций в сети

total

Общее количество станций

unactivated

Количество неактивированных станций

with_update_errors

Количество станций с ошибками обновления антивирусного ПО