Параметры запроса
Параметр
|
Описание
|
Обязательный
|
group-id
|
Идентификатор группы, станции которой будут выведены в ответе.
В ответе возвращается информация обо всех станциях заданной группы (без учета вложенности).
В данном параметре нельзя указывать системные группы, кроме Everyone.
|
нет
|
page
|
Номер страницы, которую требуется вернуть в ответе при постраничном отображении (может использоваться для вывода информации о большом количестве станций).
По умолчанию: 1.
|
нет
|
per-page
|
Количество станций на одной странице при постраничном отображении (может использоваться для вывода информации о большом количестве станций).
По умолчанию: 100.
|
нет
|
server-id
|
Идентификатор Сервера Dr.Web, к которому подключены станции
|
нет
|
state
|
Статус станций:
•activated — активированные станции,
•deinstalled — антивирусное программное обеспечение удалено со станций,
•deleted — удаленные станции,
•new — новые станции, антивирусное программное обеспечение не установлено,
•newbies — новички,
•offline — станции не в сети,
•online — станции в сети,
•unactivated — неактивированные станции,
•with_update_errors — станции с ошибками обновления антивирусного программного обеспечения.
Параметр может быть указан в запросе неограниченное количество раз для запроса информации о нескольких статусах одновременно.
|
нет
|
subgroups
|
Если параметр имеет значение yes, то в дополнение к станциям группы, указанной в параметре group-id, будут отображены станции ее вложенных подгрупп. Если в параметре group-id указано Everyone, всегда будут отображаться все станции.
По умолчанию: no.
|
нет
|
|
Параметры page и per-page работают только вместе с одним значением параметра state.
|
Пример запроса
https://192.168.1.1:9081/api/stations/list-by-state.ds?page=1&per-page=2&state=new
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1558521951" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<stations>
<new total="2">
<station id="1003" name="DRWEB-1003" last_seen_time="1587574768" last_seen_addr="tcp://192.168.10.124:1921" os="35850247" os_name="Windows 7 Professional x64"/>
<station id="1004" name="DRWEB-1004" last_seen_time="1489574584" last_seen_addr="tcp://192.168.1.2:1038" os="0" os_name="unknown"/>
</new>
</stations>
<pages total="2" current="1" objects-per-page="2"/>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <stations /> содержит информацию обо всех станциях, соответствующих запросу.
•Названия вложенных элементов элемента <stations /> соответствуют запрошенным статусам.
Атрибут каждого вложенного элемента:
Атрибут
|
Описание
|
total
|
Общее количество станций с запрошенным статусом на странице
|
▫Элемент <station /> содержит информацию о конкретной станции.
Атрибуты элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
name
|
Название станции
|
last_seen_time
|
Время последнего подключения к Серверу Dr.Web
|
last_seen_addr
|
Сетевой адрес, с которого станция последний раз подключалась к Серверу Dr.Web
|
os
|
Код операционной системы
|
os_name
|
Название операционной системы
|
onconnect
|
Действие, которое будет выполнено при следующем подключении станции к Серверу Dr.Web:
0 — ничего не будет выполнено,
1 — доступ к Серверу Dr.Web для новичка будет запрещен,
2 — доступ к Серверу Dr.Web для новичка будет разрешен.
|
state
|
Статус станции:
0 — станция не в сети,
1 — станция в сети,
2 — доступ к Серверу Dr.Web для новичка разрешен,
3 — доступ к Серверу Dr.Web для новичка запрещен.
|
|
Атрибуты onconnect и state приводятся в ответе только для станций со статусом newbies.
|
•Элемент <pages /> содержит информацию о постраничном отображении.
Атрибуты элемента <pages />:
Атрибут
|
Описание
|
total
|
Общее количество страниц
|
current
|
Номер текущей страницы
|
objects-per-page
|
Максимальное количество станций на странице
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1587680158,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "6d8f5aa0-850a-11ea-4c3c-c8efa441e4dd"}},
"data": {
"pages": {
"current": 1,
"objects_per_page": 2,
"total": 2},
"stations": {
"new": [
{"id": "1003",
"last_seen_addr": "tcp://192.168.10.124:1921",
"last_seen_time": 1587574768,
"name": "DRWEB-1003",
"os": 35850247,
"os_name": "Windows 7 Professional x64",
"state": 1},
{"id": "1004",
"last_seen_time": 0,
"name": "DRWEB-1004",
"os": 0,
"os_name": "unknown",
"state": 0}]}}}}
|
Описание параметров ответного JSON
•Блок pages содержит информацию о постраничном отображении.
Элементы блока pages:
Название поля
|
Описание
|
current
|
Номер текущей страницы
|
objects_per_page
|
Максимальное количество станций на странице
|
total
|
Общее количество страниц
|
•Блок stations содержит массивы с информацией обо всех станциях, соответствующих запросу.
▫Каждый вложенный массив содержит параметры для конкретной станции с определенным статусом. Название вложенного массива соответствует статусу станции.
Элементы объектов во вложенном массиве:
Название поля
|
Описание
|
id
|
Идентификатор станции
|
last_seen_addr
|
Сетевой адрес, с которого станция последний раз подключалась к Серверу Dr.Web
|
last_seen_time
|
Время последнего подключения к Серверу Dr.Web
|
name
|
Название станции
|
onconnect
|
Действие, которое будет выполнено при следующем подключении станции к Серверу Dr.Web:
0 — ничего не будет выполнено,
1 — доступ к Серверу Dr.Web для новичка будет запрещен,
2 — доступ к Серверу Dr.Web для новичка будет разрешен.
|
os
|
Код операционной системы
|
os_name
|
Название операционной системы
|
state
|
Статус станции:
0 — станция не в сети,
1 — станция в сети,
2 — доступ к Серверу Dr.Web для новичка разрешен,
3 — доступ к Серверу Dr.Web для новичка запрещен.
|
|
Элементы onconnect и state приводятся в ответе только для станций со статусом newbies.
|
|