|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
groups
|
Искать по группам.
Допустимые значения: yes | no. По умолчанию: yes.
|
нет
|
query
|
Строка поиска.
Осуществляется поиск соответствия в идентификаторе, имени и строке описания объекта, а также в идентификаторах пользователей.
|
да
|
stations
|
Искать по станциям.
Допустимые значения: yes | no. По умолчанию: no.
|
нет
|
Пример запроса
https://192.168.1.1:9081/api/server/search.ds?query=1&groups=yes&stations=yes
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1582030253" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<groups total="1">
<group id="20e27d73-d21d-b211-a788-85419c46f0e6" name="Everyone" description="All stations" parent_id="" parent_name="" child_groups="0" stations="2"/>
</groups>
<stations total="2">
<station id="Station1" name="Station1" parent_id="20e27d73-d21d-b211-a788-85419c46f0e6" parent_name="Everyone" description="Station 01" last_seen_time="0" last_seen_addr=""/>
<station id="2091ada3-ed5e-e611-3392-f0b9022a5484" name="win7-pro-x86-ru" parent_id="20e27d73-d21d-b211-a788-85419c46f0e6" parent_name="Everyone" description="" last_seen_time="1581930838" last_seen_addr="tcp://192.168.1.2:49285"/>
</stations>
</drweb-es-api>
|
Описание параметров ответного XML
•Элемент <groups /> содержит информацию обо всех группах, соответствующих запросу.
Атрибут элемента <groups />:
Атрибут
|
Описание
|
total
|
Общее количество групп в ответе
|
▫Элемент <group /> содержит параметры конкретной группы.
Атрибуты элемента <group />:
Атрибут
|
Описание
|
id
|
Идентификатор группы
|
name
|
Название группы
|
description
|
Строка описания
|
parent_id
|
Идентификатор родительской группы
|
parent_name
|
Название родительской группы
|
child_groups
|
Количество дочерних групп
|
stations
|
Количество станций, входящих в данную группу
|
•Элемент <stations /> содержит информацию обо всех станциях, соответствующих запросу.
Атрибут элемента <stations />:
Атрибут
|
Описание
|
total
|
Общее количество станций в ответе
|
▫Элемент <station /> содержит параметры конкретной станции.
Атрибуты элемента <station />:
Атрибут
|
Описание
|
id
|
Идентификатор станции
|
name
|
Название станции
|
parent_id
|
Идентификатор первичной группы
|
parent_name
|
Название первичной группы
|
description
|
Строка описания
|
last_seen_time
|
Время последнего подключения станции к Серверу Dr.Web
|
last_seen_addr
|
Адрес, с которого станция последний раз подключалась к Серверу Dr.Web
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1582030510,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},
"data": {
"groups": {
"total": 1,
"list": [
{"id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"name": "Everyone",
"parent_id": null,
"parent_name": null,
"child_groups": 0,
"stations": 2,
"description": "All stations"}]},
"stations": {
"total": 2,
"list": [
{"id": "Station1",
"name": "Station1",
"parent_id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"parent_name": "Everyone",
"description": "Station 01",,
"last_seen_at": 0,
"last_seen_addr": null}
{"id": "2091ada3-ed5e-e611-3392-f0b9022a5484",
"name": "WIN-7-PRO-SP1-X",
"parent_id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"parent_name": "Everyone",
"description": null,
"last_seen_at": 1489567785,
"last_seen_addr": "tcp://192.168.233.131:49285"}]}}}
|
Описание параметров ответного JSON
•Блок groups содержит информацию обо всех группах, соответствующих запросу.
Элементы блока groups:
Название поля
|
Описание
|
total
|
Общее количество групп в ответе
|
list
|
Массив параметров для каждой группы
|
▫Каждый объект массива list содержит параметры конкретной группы.
Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор группы
|
name
|
Название группы
|
parent_id
|
Идентификатор родительской группы
|
parent_name
|
Название родительской группы
|
child_groups
|
Количество дочерних групп
|
stations
|
Количество станций, входящих в данную группу
|
description
|
Строка описания
|
•Блок stations содержит информацию обо всех станциях, соответствующих запросу.
Элементы блока stations:
Название поля
|
Описание
|
total
|
Общее количество станций в ответе
|
list
|
Массив параметров для каждой станции
|
▫Каждый объект массива list содержит параметры конкретной станции.
Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор станции
|
name
|
Название станции
|
parent_id
|
Идентификатор первичной группы
|
parent_name
|
Название первичной группы
|
description
|
Строка описания
|
last_seen_at
|
Время последнего подключения станции к Серверу Dr.Web
|
last_seen_addr
|
Адрес, с которого станция последний раз подключалась к Серверу Dr.Web
|
|