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