|
Параметры запроса
Параметр
|
Описание
|
Обязательный
|
object
|
Объект в Карантине.
Параметр может быть указан в запросе неограниченное количество, чтобы восстановить несколько объектов из Карантина одновременно.
|
да
|
Возвращаемые ошибки
1.Если Карантин отключен на Сервере, скрипт вернет ошибку:
code = 144
message ='Quarantine is disabled on Server'
|
2.Если Карантин не доступен для станции, то скрипт вернет ошибку:
code = 145
message ='Quarantine is unavailable'
|
Пример запроса
Из ответного XML на запрос о Получении состояния Карантина станций берем следующие параметры:
<object> = 8f7b2c47-8e9b-11e9-5812-dcfdccec8a94
<station_id> = 2091ada3-ed5e-e611-3392-f0b9022a5484
<q_time> = 20190614115718980
При построении запроса на восстановление объекта из Карантина параметр object формируется следующим образом: <object>%3A<station_id>%3A<q_time>.
В результате получаем запрос вида:
http://192.168.1.1:9080/api/quarantine/restore.ds?object=8f7b2c47-8e9b-11e9-5812-dcfdccec8a94%3A2091ada3-ed5e-e611-3392-f0b9022a5484%3A20190614115718980
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.0" timestamp="1560533442" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<items>
<object status="delayed">8f7b2c47-8e9b-11e9-5812-dcfdccec8a94:2091ada3-ed5e-e611-3392-f0b9022a5484:20190614115718980</object>
</items>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <items /> содержит информацию обо всех объектах, для которых было запрошено восстановление из Карантина.
•Элемент <object /> содержит информацию о конкретном объекте Карантина. Атрибут элемента <object />:
Атрибут
|
Описание
|
status
|
Статус выполнения восстановления. Может принимать значения:
•initiated — восстановление инициировано, •delayed — восстановление отложено, •failed — восстановление завершилось с ошибкой. |
Значение элемента <object /> содержит информацию о восстанавливаемом объекте, аналогичную информации, передаваемой в аргументе object из изначального запроса.
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1560535448,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "76b05bc0-8691-11e9-63e5-7036cecd07fa"}},
"data": {
"8f7b2c47-8e9b-11e9-5812-dcfdccec8a94:2091ada3-ed5e-e611-3392-f0b9022a5484:20190614115718980": "delayed"}}
|
Описание параметров ответного JSON
Блок data содержит информацию обо всех объектах, для которых было запрошено восстановление из Карантина.
Элементы блока data:
Название поля
|
Описание
|
Соответствует значению параметра object из запроса
|
Статус выполнения восстановления. Может принимать значения:
•initiated — восстановление инициировано, •delayed — восстановление отложено, •failed — восстановление завершилось с ошибкой. |
|