|
Параметр запроса
Параметр
|
Описание
|
Обязательный
|
object
|
Объект в Карантине.
Параметр может быть указан в запросе неограниченное количество, чтобы удалить несколько объектов из Карантина одновременно.
|
да
|
Возвращаемые ошибки
1.Если Карантин отключен на Сервере Dr.Web, то скрипт вернет ошибку:
code = 144
message ='Quarantine is disabled on Server'
|
2.Если Карантин не доступен для станции, то скрипт вернет ошибку:
code = 145
message ='Quarantine is unavailable'
|
Пример запроса
При построении запроса на удаление объекта из Карантина параметр object формируется следующим образом: <object>%3A<station_id>%3A<q_time>. Параметр <station_id> — это идентификатор станции, указанный в запросе Получение состояния Карантина. Параметры <object> и <q_time> берем из ответа на этот запрос.
Из примера запроса Получение состояния Карантина:
<station_id> = 1002
<object> = Fc45be5fbe1f9f0b64f9a58fa898b73d913ad494aabb4aa9341c96737600fa44
<q_time> = 20200422110324000
В результате получаем запрос вида:
https://192.168.1.1:9081/api/quarantine/delete.ds?object=Fc45be5fbe1f9f0b64f9a58fa898b73d913ad494aabb4aa9341c96737600fa44%3A1002%3A20200422110324000
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1588772053" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<items>
<object status="initiated">Fc45be5fbe1f9f0b64f9a58fa898b73d913ad494aabb4aa9341c96737600fa44:1002:20200422110324000</object>
</items>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <items /> содержит информацию об удалении всех объектов Карантина, указанных в запросе.
•Элемент <object /> содержит информацию о конкретном объекте Карантина.
Атрибут элемента <object />:
Атрибут
|
Описание
|
status
|
Статус выполнения удаления объекта:
•initiated — удаление инициировано,
•delayed — удаление отложено,
•failed — удаление завершилось с ошибкой. |
Значение элемента <object /> содержит информацию о удаляемом объекте, аналогичную информации, передаваемой в аргументе object из изначального запроса.
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1588772153,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "d43ec7c0-846c-11ea-56fb-d8e582d45004"}},
"data": {
"Fc45be5fbe1f9f0b64f9a58fa898b73d913ad494aabb4aa9341c96737600fa44:1002:20200422110324000": "delayed"}}
|
Описание параметров ответного JSON
Блок data содержит информацию об удалении всех объектов Карантина, указанных в запросе.
Элементы блока data:
Название поля
|
Описание
|
Соответствует значению параметра object из запроса
|
Статус выполнения удаления объекта:
•initiated — удаление инициировано,
•delayed — удаление отложено,
•failed — удаление завершилось с ошибкой. |
|