Получение списка станций по статусу

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

Параметр

Описание

Примечание

group-id

Идентификатор группы, станции которой будут выведены в ответе

Обязательный параметр: нет.

В ответе возвращается информация обо всех станциях заданной группы (без учета вложенности).

page

Номер страницы, которую требуется вернуть в ответе при постраничном отображении (может использоваться для вывода информации о большом количестве станций)

Обязательный параметр: нет.

По умолчанию 1

per-page

Количество записей на одной странице

Обязательный параметр: нет.

По умолчанию 100

server-id

Идентификатор Сервера, к которому подключены станции

Обязательный параметр: нет

state

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

online — станции в сети,

offline — станции не в сети,

activated — активированные станции,

unactivated — неактивированные станции,

deinstalled — антивирусное ПО удалено со станций,

new — новые станции, антивирусное ПО не установлено,

newbies — новички,

with_update_errors — станции с ошибками обновления антивирусного ПО,

deleted — удаленные станции.

Обязательный параметр: нет

Параметры page и per-page работают только с атрибутом state.

 

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

http://192.168.1.1:9080/api/stations/list-by-state.ds?page=1&per-page=3&state=newbies

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

 

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

<drweb-es-api api_version="4.3.0" timestamp="1558521951" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <stations>
     <newbies total="5">
        <station id="1001" name="DRWEB-1001" last_seen_time="1489574768" last_seen_addr="tcp://192.168.1.2:1921" os="35850247" os_name="Windows 7 Professional x64" onconnect="0" state="1"/>

        <station id="1002" name="DRWEB-1002" last_seen_time="1489574584" last_seen_addr="tcp://192.168.1.2:1038" os="" os_name="" onconnect="2" state="0"/>

        <station id="1003" name="DRWEB-1003" last_seen_time="1489574768" last_seen_addr="tcp://192.168.1.2:1189" os="" os_name="" onconnect="0" state="0"/>
     </newbies>
  </stations>

  <pages total="2" current="1" objects-per-page="3"/>
</drweb-es-api>

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

Элемент <stations /> содержит информацию обо всех станциях с запрошенным статусом, названия вложенных элементов соответствуют запрошенным статусам.

Атрибут каждого вложенного элемента:

Атрибут

Описание

total

Общее количество станций с запрошенным статусом

Элемент <station /> содержит информацию о конкретной станции.

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

Атрибут

Описание

id

Идентификатор станции

name

Название станции

last_seen_time

Время последнего подключения к Серверу

last_seen_addr

Сетевой адрес, с которого станция последний раз подключалась к Серверу

os

Код операционной системы

os_name

Название операционной системы

onconnect

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

0 — ничего не будет выполнено,

1 — доступ к Серверу для новичка будет запрещен,

2 — доступ к Серверу для новичка будет разрешен.

state

Статус станции. Может принимать значения:

0 — станция не в сети,

1 — станция в сети,

2 — доступ к Серверу для новичка разрешен,

3 — доступ к Серверу для новичка запрещен.

Элемент <pages /> содержит информацию о выводимых страницах.

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

Атрибут

Описание

total

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

current

Номер текущей страницы

objects-per-page

Количество записей на одной странице

 

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

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

    "timestamp": 1558522039,

    "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": {
    "pages": {
      "current": 1,

      "objects_per_page": 3,
      "total": 2},

    "stations": {
      "newbies": {
          "total": 5,

"list": [
   {"id": "1001",

    "last_seen_addr": "tcp://192.168.10.124:1921",

    "last_seen_time": 1489574768,

    "name": "DRWEB-1001",

  "onconnect": 0,

    "os": 35850247,

    "os_name": "Windows 7 Professional x64",
    "state": 1},

  {"id": "1002",
    "last_seen_time": 1489574584,

    "last_seen_addr": "tcp://192.168.10.124:1038",

    "name": "DRWEB-1002",

    "onconnect": 2,

    "os": 0,

    "os_name": "unknown",
    "state": 0},

   {"id": "1003",
    "last_seen_time": 1489574768,

    "last_seen_addr": "tcp://192.168.10.124:1189",

    "name": "DRWEB-1003",

    "onconnect": 0,

    "os": 0,

    "os_name": "unknown",
    "state": 0}]}}}}

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

Блок pages содержит информацию о количестве выводимых записей.

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

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

Описание

current

Номер текущей страницы

objects_per_page

Количество записей на одной странице

total

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

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

Элементы каждого вложенного блока:

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

Описание

total

Общее количество станций с запрошенным статусом

Массив list содержит информацию о конкретных станциях.

Элементы объектов в массиве list:

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

Описание

id

Идентификатор станции

last_seen_addr

Сетевой адрес, с которого станция последний раз подключалась к Серверу

last_seen_time

Время последнего подключения к Серверу

name

Название станции

onconnect

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

0 — ничего не будет выполнено,

1 — доступ к Серверу для новичка будет запрещен,

2 — доступ к Серверу для новичка будет разрешен.

os

Код операционной системы

os_name

Название операционной системы

state

Статус станции. Может принимать значения:

0 — станция не в сети,

1 — станция в сети,

2 — доступ к Серверу для новичка разрешен,

3 — доступ к Серверу для новичка запрещен.