|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
id
|
Идентификатор группы.
В ответе возвращается информация обо всех станциях заданной группы (без учета вложенности). Возможно получение списка станций для системных групп.
|
да
|
page
|
Номер страницы, которую требуется вернуть в ответе при постраничном отображении (может использоваться для вывода информации о большом количестве станций).
По умолчанию: 1.
|
нет
|
per-page
|
Количество станций на одной странице при постраничном отображении (может использоваться для вывода информации о большом количестве станций).
По умолчанию: 100.
|
нет
|
server-id
|
Идентификатор Сервера Dr.Web, с которого запрашивается информация
|
нет
|
station-type
|
Если параметр имеет значение yes, то в ответе будет приведена информация о типе станции.
По умолчанию: no.
|
нет
|
subgroups
|
Если параметр имеет значение yes, то в дополнение к станциям группы, указанной в параметре id, будут отображены станции ее вложенных подгрупп. Если в параметре id указаны системные группы, всегда будут отображаться все станции.
По умолчанию: no.
|
нет
|
show-blocked-stations
|
Если параметр имеет значение no, то не будут отображаться заблокированные станции.
По умолчанию: yes.
|
нет
|
Пример запроса
https://192.168.1.1:9081/api/groups/stations-list.ds?id=20e27d73-d21d-b211-a788-85419c46f0e6&per-page=1&station-type=yes
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
В параметре id указана группа, в которой находятся обычные станции (не виртуальный агент и не сканирующий сервер), и в запросе используется параметр station-type.
<drweb-...>
<stations total="1">
<station...>
<station_type_info station_type="0"/>
</station>
</stations>
<pages.../>
</drweb-...>
|
В параметре id указана группа, в которой находятся виртуальные агенты или сканирующие серверы, и в запросе используется параметр station-type.
<drweb-es-api api_version="4.3.2" timestamp="1699624500" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<stations total="1">
<station id="s1" name="s1003" last_seen_time="1699623066" last_seen_addr="tcp://10.0.2.2:38066" state="1" os="16842752" os_name="Linux" login_addr="10.0.2.2" login_mac="08:00:27:17:16:f0" createtime="20231110132600486" blockbeg="0" blockend="0">
<station_type_info station_type="2">
<station id="s2" name="DESKTOP-1" station_type="1"/>
</station_type_info>
</station>
</stations>
<pages total="2" current="1" objects-per-page="1"/>
</drweb-es-api>
|
Описание параметров ответного XML
•Элемент <stations /> содержит список станций в группе, указанной в запросе.
Атрибут элемента <stations />:
Атрибут
|
Описание
|
total
|
Общее количество станций заданной группы
|
▫Элемент <station /> содержит параметры конкретной станции группы.
Атрибуты элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
name
|
Название станции
|
last_seen_time
|
Время последнего подключения к Серверу Dr.Web
|
last_seen_addr
|
Адрес, с которого станция последний раз подключалась к Серверу Dr.Web
|
state
|
Текущее состояние станции (см. Приложение Г. Возвращаемые коды состояния станции)
|
os
|
Код операционной системы
|
os_name
|
Название операционной системы
|
login_addr
|
IP-адрес станции
|
login_mac
|
MAC-адрес сетевого интерфейса станции
|
createtime
|
Дата и время создания станции
|
blockbeg
|
Дата и время начала блокировки
|
blockend
|
Дата и время окончания блокировки
|
•Элемент <station_type_info /> содержит информацию о типе станции. Если станция является виртуальным агентом, содержит список сканирующих серверов. Если станция является сканирующим сервером, содержит список виртуальных агентов. Если это обычная станция, то пустой список.
Атрибуты элемента <station_type_info />:
Атрибут
|
Описание
|
station_type
|
Тип станции:
•0 — обычная,
•1 — Виртуальный агент,
•2 — Сканирующий сервер |
•Элемент <station /> содержит параметры конкретной станции.
Атрибуты элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
name
|
Название станции
|
station_type
|
Тип станции:
•0 — обычная,
•1 — Виртуальный агент,
•2 — Сканирующий сервер |
•Элемент <pages /> содержит информацию о постраничном отображении.
Атрибуты элемента <pages />:
Атрибут
|
Описание
|
total
|
Общее количество страниц
|
current
|
Номер текущей страницы
|
objects-per-page
|
Максимальное количество станций на странице
|
Ответ в формате JSON
В параметре id указана группа, в которой находятся обычные станции (не виртуальный агент и не сканирующий сервер), и в запросе используется параметр station-type.
{"data": {
"stations": {
"total":1,
"list":[
{...
"name": ...,
...
"station_type_info":{
"list":[],
"station_type":0}}]},
"pages": ...
|
В параметре id указана группа, в которой находятся виртуальные агенты или сканирующие серверы, и в запросе используется параметр station-type.
{"data":{
"pages":{
"current":1,
"objects_per_page":1,
"total":2},
"stations":{
"list":[
{"blockbeg":0,
"blockend":0,
"createtime":20231110132600486,
"id":"s1",
"last_seen_addr":"tcp://10.0.2.2:38066",
"last_seen_time":1699623066,
"login_addr":"10.0.2.2",
"login_mac":"08:00:27:17:16:f0",
"name":"s1003",
"os_code":16842752,
"os_name":"Linux",
"state":1,
"station_type_info":{
"list":[
{"id":"s2",
"name":"DESKTOP-1",
"station_type":1}],
"station_type":2}}],
"total":1}},
"head":{
"api":{
"version":40302,
"versionString":"4.3.2"},
"server":{
"name":"192.168.1.1",
"uuid":"b35d999d-9212-481d-af8c-8551c4113383",
"version":"13.00.1.202310121"},
"status":true,
"timestamp":1699624578}}
|
Описание параметров ответного JSON
•Блок pages содержит информацию о постраничном отображении.
Элементы блока pages:
Название поля
|
Описание
|
current
|
Номер текущей страницы
|
objects_per_page
|
Максимальное количество станций на странице
|
total
|
Общее количество страниц
|
•Блок stations содержит список станций в группе, указанной в запросе.
Элементы блока stations:
Название поля
|
Описание
|
total
|
Общее количество станций заданной группы
|
list
|
Массив параметров для каждой станции группы
|
▫Каждый объект массива list содержит параметры конкретной станции заданной группы.
Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор станции
|
name
|
Название станции
|
last_seen_time
|
Время последнего подключения к Серверу Dr.Web
|
last_seen_addr
|
Адрес, с которого станция последний раз подключалась к Серверу Dr.Web
|
state
|
Текущее состояние станции (см. Приложение Г. Возвращаемые коды состояния станции)
|
os_code
|
Код операционной системы
|
os_name
|
Название операционной системы
|
login_addr
|
IP-адрес станции
|
login_mac
|
MAC-адрес сетевого интерфейса станции
|
createtime
|
Дата и время создания станции
|
blockbeg
|
Дата и время начала блокировки
|
blockend
|
Дата и время окончания блокировки
|
station_type_info
|
Содержит информацию о типе станции.
|
•Блок <station_type_info /> содержит информацию о типе станции. Если станция является виртуальным агентом, содержит список сканирующих серверов. Если станция является сканирующим сервером, содержит список виртуальных агентов. Если это обычная станция, то пустой список.
Элементы блока <station_type_info />:
Название поля
|
Описание
|
station_type
|
Тип станции:
•0 — обычная,
•1 — Виртуальный агент,
•2 — Сканирующий сервер |
list
|
Массив параметров для каждой станции.
|
▫Каждый объект массива list содержит параметры конкретной станции.
Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор станции
|
name
|
Название станции
|
station_type
|
Тип станции:
•0 — обычная,
•1 — Виртуальный агент,
•2 — Сканирующий сервер |
|