|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
group-id
|
Идентификатор группы, станции которой будут выведены в ответе.
В ответе возвращается информация обо всех станциях заданной группы (без учета вложенности).
|
нет
|
page
|
Номер страницы, которую требуется вернуть в ответе при постраничном отображении (может использоваться для вывода информации о большом количестве станций).
По умолчанию: 1.
|
нет
|
per-page
|
Количество станций на одной странице при постраничном отображении (может использоваться для вывода информации о большом количестве станций).
По умолчанию: 100.
|
нет
|
server-id
|
Идентификатор Сервера Dr.Web, к которому подключены станции
|
нет
|
station-type
|
Тип станции:
•0 - полный агент,
•1 - Виртуальный агент,
•2 - Сканирующий сервер.
Данный параметр может быть использован несколько раз для получения информации о нескольких типах станций. Если параметр не указывается, будет получена информация обо всех типах станций.
|
нет
|
Пример запроса
https://192.168.1.1:9081/api/stations/list-by-type.ds?station-type=1
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1640088998" server="localhost" srv_version="13.00.0.202005090" status="true">
<stations type="virtual_agent" total="2">
<station id="7abaef16-0e1e-4331-954f-8faa48165022" name="DESKTOP-mesh" last_seen_addr="tcp://10.0.2.2:57144" last_seen_time="1639644820" os="35851780" os_name="Windows 10 Enterprise"/>
<station id="d3e61524-2a9f-4f4a-8ebc-50ac2281dc53" name="DESKTOP-mesh-1" last_seen_addr="tcp://10.0.2.2:57086" last_seen_time="1638263222" os="35851780" os_name="Windows 10 Enterprise"/>
</stations>
<pages total="1" current="1" objects-per-page="100"/>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <stations /> содержит информацию обо всех станциях, соответствующих запросу.
•Атрибуты элемента <stations />:
Атрибут
|
Описание
|
total
|
Общее количество станций с запрошенным типом на странице
|
type
|
Тип станций:
•regular - полный агент,
•virtual_agent - Виртуальный агент,
•scanning_server - Сканирующий сервер. |
▫Элемент <station /> содержит информацию о конкретной станции.
Атрибуты элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
name
|
Название станции
|
last_seen_time
|
Время последнего подключения к Серверу Dr.Web
|
last_seen_addr
|
Сетевой адрес, с которого станция последний раз подключалась к Серверу Dr.Web
|
os
|
Код операционной системы
|
os_name
|
Название операционной системы
|
•Элемент <pages /> содержит информацию о постраничном отображении.
Атрибуты элемента <pages />:
Атрибут
|
Описание
|
total
|
Общее количество страниц
|
current
|
Номер текущей страницы
|
objects-per-page
|
Максимальное количество станций на странице
|
Ответ в формате JSON
{"head":{
"api":{
"version":"40302",
"versionString":"4.3.2"},
"server":{
"name":"localhost",
"uuid":"54200799-9bb5-4079-805e-0431dc858d84",
"version":"13.00.0.202005090"},
"status":true,
"timestamp":1640089456},
"data":[{
"pages":{
"current":1,
"objects_per_page":100,
"total":1},
"stations":{
"virtual_agent":[{
"id":"7abaef16-0e1e-4331-954f-8faa48165022",
"last_seen_addr":"tcp://10.0.2.2:57144",
"last_seen_time":1639644820,
"name":"DESKTOP-mesh",
"os":35851780,
"os_name":"Windows 10 Enterprise"},{
"id":"d3e61524-2a9f-4f4a-8ebc-50ac2281dc53",
"last_seen_addr":"tcp://10.0.2.2:57086",
"last_seen_time":1638263222,
"name":"DESKTOP-mesh-1",
"os":35851780,
"os_name":"Windows 10 Enterprise"}]}}]}
|
|
|
Описание параметров ответного JSON
•Блок pages содержит информацию о постраничном отображении.
Элементы блока pages:
Название поля
|
Описание
|
current
|
Номер текущей страницы
|
objects_per_page
|
Максимальное количество станций на странице
|
total
|
Общее количество страниц
|
•Блок stations содержит массивы с информацией обо всех станциях, соответствующих запросу.
▫Каждый вложенный массив содержит параметры для конкретной станции с определенным типом. Название вложенного массива соответствует типу станции.
Элементы объектов во вложенном массиве:
Название поля
|
Описание
|
id
|
Идентификатор станции
|
last_seen_addr
|
Сетевой адрес, с которого станция последний раз подключалась к Серверу Dr.Web
|
last_seen_time
|
Время последнего подключения к Серверу Dr.Web
|
name
|
Название станции
|
os
|
Код операционной системы
|
os_name
|
Название операционной системы
|
|