Для получения ответа в XML-формате необходимо отправить запрос вида:
https://<host>:9081/api/<объект>/<сценарий>.ds?<параметры> |
где:
<host> — IP-адрес или DNS-имя компьютера с установленным Сервером Dr.Web;
<объект> — объект управления: станция, группа, Сервер Dr.Web, администратор, Карантин.
Доступные сценарии запросов и их параметры приведены в разделах:
•7. Работа с администраторами,
•8. Работа с группами администраторов.
|
Знак «-» в названии сценария может быть заменен на знак «_». Например, ответы на запросы по сценариям installed-components.ds и installed_components.ds будут идентичны. |
В ответ возвращается xml-документ следующего вида:
<drweb-es-api api_version="4.3.2" timestamp="1579467853" server="192.168.1.1" srv_version="13.00.1.202310121" status="true"> <!-- etc. Skipped in documentation --> </drweb-es-api> |
Атрибуты корневого элемента <drweb-es-api />:
Атрибут |
Описание |
|---|---|
api_version |
Текущая версия Web API |
timestamp |
Время Сервера Dr.Web по GMT (в формате UNIX timestamp) |
server |
Доменное имя или IP-адрес Сервера Dr.Web |
srv_version |
Полная версия Dr.Web Enterprise Security Suite |
status |
Статус запроса. Значение true — запрос отработан успешно, false — возникла ошибка, запрос не отработан. |
Если во время выполнения произошла ошибка (status=’false’), то в теле XML-документа присутствует элемент <error />, в котором содержатся код и текст ошибки. Описание ошибки приводится в элементе <message />, а код ошибки — в элементе <errno />.
<drweb-es-api api_version="4.3.2" timestamp="1579450629" server="192.168.1.1" srv_version="13.00.1.202310121" status="false"> <error> <errno>36</errno> <message>Unable to remove group '411dac63-2a3e-4ce8-af4f-1fbeb94242ef': You cannot remove the system group</message> </error> </drweb-es-api> |
См. Приложение В. Возвращаемые коды ошибок, которое содержит перечень кодов ошибок.
Во всех элементах всех сценариев Web API 4.3.2 дата и время возвращается в формате Unix timestamp.