Download PDF
Download page REST API. Доступные команды диспетчера. Webui.
REST API. Доступные команды диспетчера. Webui
Доступные команды модуля «webui»
Команды, связанные со списками устройств доступа
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список устройств доступа |
| GET | Возвращает устройство доступа с идентификатором {uuid} |
/api/webui/draft/access-devices/{uuid}/{status} | PATCH | Изменяет статус устройства доступа с идентификатором {uuid} |
Команды, связанные со списками доступа
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список объектных разрешений |
| POST | Обновляет объектное разрешение |
/api/webui/draft/acl/{ID} | GET | Возвращает объектное разрешение с идентификатором {ID} |
| PUT | Обновляет объектное разрешение с идентификатором {ID} |
| DELETE | Удаляет объектное разрешение с идентификатором {ID} |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список разрешений для переданного типа объекта |
| GET | Возвращает список доступных типов объектных разрешений |
Команды, связанные с объектами инфраструктуры
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список объектов инфраструктуры («Универсальных диспетчеров») |
| DELETE | Удаляет объект инфраструктуры («Универсальный диспетчер») с идентификатором {uuid} |
| GET | Возвращает список объектов инфраструктуры («Шлюзов») |
| DELETE | Удаляет объект инфраструктуры («Шлюз») с идентификатором {uuid} |
| GET | Возвращает список объектов инфраструктуры (порталов) |
| DELETE | Удаляет объект инфраструктуры (портал) с идентификатором {uuid} |
| GET | Возвращает список объектов инфраструктуры («Менеджеров рабочих мест») |
| DELETE | Удаляет объект инфраструктуры («Менеджер рабочих мест») с идентификатором {uuid} |
Команды, связанные с журналами событий
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список событий аудита |
| GET | Возвращает список доступных типов событий аудита |
Команды, связанные с доменами аутентификации
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список доменов аутентификации |
| POST | Создает домен аутентификации |
| GET | Возвращает список групп домена аутентификации |
| POST | Создает группу домена аутентификации |
| GET | Возвращает группу с идентификатором {uuid} домена аутентификации с идентификатором {auth_uuid} |
| PUT | Обновляет группу домена аутентификации |
| DELETE | Удаляет группу домена аутентификации |
| GET | Возвращает список ВРМ группы домена аутентификации |
| GET | Возвращает список пользователей группы домена аутентификации |
| GET | Возвращает список доступных групп для домена аутентификации |
| GET | Возвращает список доступных типов групп домена аутентификации |
| GET | Возвращает описание для графического интерфейса группы с типом {group_type} |
| GET | Возвращает список пользователей домена аутентификации |
| POST | Создает пользователя домена аутентификации |
| GET | Возвращает пользователя с идентификатором {uuid} домена аутентификации |
| PUT | Обновляет пользователя домена аутентификации |
| DELETE | Удаляет пользователя домена аутентификации |
| GET | Возвращает журнал пользователя домена аутентификации |
| GET | Возвращает список ВРМ пользователя домена аутентификации |
| GET | Возвращает список ассоциированных виртуальных машин для пользователя домена аутентификации |
| GET | Возвращает список доступных пользователей для домена аутентификации |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список доступных типов пользователей домена аутентификации |
| GET | Возвращает домен аутентификации |
| PUT | Обновляет домен аутентификации |
| DELETE | Удаляет домен аутентификации |
| GET | Возвращает журнал домена аутентификации |
| GET | Возвращает список доступных типов доменов аутентификации |
| GET | Возвращает описание для графического интерфейса домена аутентификации с типом {data_type} |
| POST | Тестирует параметры домена аутентификации |
Команды, связанные с панелью мониторинга
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Просмотр списка объектов панели мониторинга |
Команды, связанные с изображениями гостевых ОС
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список изображений |
| POST | Создает изображение |
| GET | Возвращает изображение с идентификатором {uuid} |
| PUT | Обновляет изображение |
| DELETE | Удаляет изображение |
| GET | Возвращает описание для графического интерфейса |
Команды, связанные с графическим интерфейсом
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Доступ к callback-функциям графического интерфейса |
Команды, связанные с получением индекса
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Определяет текущую версию REST API |
Команды, связанные с функциями мониторинга
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Просмотр всех журналов в виде списка |
Команды, связанные с аутентификацией на основе адресов сети
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список сетей |
| POST | Создает сеть |
| GET | Возвращает сеть с идентификатором {uuid} |
| PUT | Обновляет сеть |
| DELETE | Удаляет сеть |
| GET | Возвращает описание для графического интерфейса |
Команды, связанные с параметрами гостевых ОС
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список параметров гостевых ОС |
| POST | Создает параметры гостевых ОС |
| GET | Возвращает параметры гостевых ОС с идентификатором {uuid} |
| PUT | Обновляет параметры гостевых ОС |
| DELETE | Удаляет параметры гостевых ОС |
| GET | Возвращает список типов параметров гостевых ОС |
| GET | Возвращает описание для графического интерфейса для параметров с типом {data_type} |
Команды, связанные с глобальными политиками
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Список всех доступных политик |
| GET | Получить информацию о политике с типом {data_type} |
| PUT | Обновить параметры политики |
| DELETE | Сброс глобальной политики |
| GET | Спецификация полей графического интерфейса для политики конкретного типа |
Команды, связанные с поставщиками ресурсов
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список поставщиков ресурсов |
| POST | Создает поставщика ресурсов |
| GET | Возвращает поставщик ресурсов с идентификатором {uuid} |
| PUT | Обновляет поставщик ресурсов |
| DELETE | Удаляет поставщик ресурсов |
| PATCH | Переводит поставщик ресурсов в режим техобсуживания |
| GET | Возвращает список доступных типов поставщиков техобслуживания |
| POST | Тестирует параметры поставщика ресурсов |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список шаблонов ВРМ поставщика ресурсов |
| POST | Создает шаблон ВРМ |
| GET | Возвращает шаблон ВРМ с идентификатором {uuid} поставщика ресурсов |
| PUT | Обновляет шаблон ВРМ с идентификатором {uuid} поставщика ресурсов |
| DELETE | Удаляет шаблон ВРМ с идентификатором {uuid} поставщика ресурсов |
| GET | Возвращает список доступных типов шаблонов ВРМ поставщика ресурсов |
| GET | Возвращает описание для графического интерфейса для шаблона ВРМ с типом {service_type} поставщика ресурсов |
Команды, связанные с управлением полномочиями (ролями)
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список ролей |
| POST | Создает роль |
| GET | Возвращает роль |
| PUT | Обновляет роль |
| DELETE | Удаляет роль |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список разрешений для ролей |
Команды, связанные с отчетами
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список отчетов |
| POST | Создает отчет |
| GET | Возвращает отчет |
| PUT | Обновляет отчет |
| DELETE | Удаляет отчет |
| GET | Генерирует отчет с идентификатором {id} |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список доступных типов отчетов |
Команды, связанные с фондами ВРМ
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список фондов ВРМ |
| POST | Создает фонд ВРМ |
| GET | Возвращает фонд ВРМ |
| PUT | Обновляет фонд ВРМ |
| DELETE | Удаляет фонд ВРМ |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список доступных типов для фондов ВРМ |
| GET | Возвращает список групп фонда ВРМ |
| POST | Добавляет группу в фонд ВРМ |
| GET | Набор операций для управления группой из фонда ВРМ |
| DELETE | Удаляет группу с идентификатором {uuid} из фонда ВРМ |
| GET | Возвращает описание для графического интерфейса |
| GET | Список всех политик фонда ВРМ |
| PUT | Создает политику фонда ВРМ |
| GET | Получает информацию о политиках фонда ВРМ |
| PUT | Обновляет параметры политики фонда ВРМ |
| DELETE | Сброс политики фонда ВРМ |
| GET | Спецификация полей графического интерфейса для политики типа {data_type} |
| GET | Запускает процедуру публикации фонда ВРМ |
| GET | Возвращает список публикаций фонда ВРМ |
| GET | Возвращает публикацию с идентификатором {uuid} |
| GET | Запускает отмену публикации фонда ВРМ. Повторный вызов запускает форсированную отмену публикации фонда ВРМ |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список протоколов доставки из фонда ВРМ |
| POST | Добавляет протокол доставки в фонд ВРМ |
| GET | Возвращает протокол доставки с идентификатором {uuid} из фонда ВРМ |
| DELETE | Удаляет протокол доставки с идентификатором {uuid} из фонда ВРМ |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список пользователей фонда ВРМ |
| POST | Добавляет пользователя в фонд ВРМ |
| GET | Набор операций для управления пользователями из фонда ВРМ |
| DELETE | Удаляет пользователя из фонда ВРМ |
| GET | Возвращает описание для графического интерфейса |
| GET | Получение списка ВРМ, находящихся в кеше фонда ВРМ |
| GET | Возвращает ВРМ, находящееся в кеше фонда ВРМ |
| DELETE | Удаляет ВРМ, находящееся в кеше из фонда ВРМ |
| PATCH | Назначает пользователю ВРМ, находящееся в кеше |
| GET | Возвращает описание для графического интерфейса ВРМ, находящегося в кеше |
| GET | Возвращает журнал ВРМ, находящегося в кеше |
| PATCH | Управление режимом техобслуживания ВРМ, находящегося в кеше |
| PATCH | Управление состоянием выбранного ВРМ, находящегося в кеше |
| GET | Возвращает журнал фонда ВРМ |
| GET | Получает список назначенных ВРМ из фонда ВРМ |
| GET | Возвращает назначенное ВРМ из фонда ВРМ |
| DELETE | Удаляет назначенное ВРМ из фонда ВРМ |
| GET | Возвращает журнал назначенного ВРМ |
| PATCH | Переводит фонд ВРМ в режим техобслуживания и возвращает из него |
| PATCH | Управление состоянием назначенного ВРМ |
| PATCH | Откат назначенной ВМ на базовый снапшот |
| PATCH | Замена назначенного экземпляра ВМ на новый (запись в базе данных о ВРМ остается та же) |
| PATCH | Управление режимом техобслуживания назначенного ВРМ |
| POST | Отправка сообщения назначенным ВРМ |
| GET | Возвращает описание для графического интерфейса метода отправки сообщения ВРМ |
Команды, связанные с группами ВРМ
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список групп |
| POST | Создает группу |
| GET | Возвращает группу с идентификатором {uuid} |
| PUT | Обновляет группу |
| DELETE | Удаляет группу |
| GET | Возвращает описание для графического интерфейса |
Команды, связанные с сессиями пользователей
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список активных сессий пользователей |
| GET | Возвращает активную сессию пользователя |
| PATCH | Сбрасывает активную сессию пользователя |
| PATCH | Останавливает активную сессию пользователя |
| PATCH | Генерация уникального URL для подключения к «Удаленному помощнику» |
Команды, связанные с системными параметрами
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список системных параметров |
| PUT | Сохранение параметров конфигурации |
Команды, связанные с протоколами доставки
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список протоколов доставки |
| POST | Создает протокол доставки |
| GET | Возвращает протокол доставки |
| PUT | Обновляет протокол доставки |
| DELETE | Удаляет протокол доставки |
| GET | Возвращает список типов протоколов доставки |
| GET | Возвращает описание для графического интерфейса |
| POST | Тестирует параметры протокола доставки |
Команды, связанные с работой мастеров
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список мастеров |
| DELETE | Удаляет мастер с идентификатором {uuid} |
| PATCH | Создает объект после валидации собранных данных. Удаляет мастер из временного хранилища |
| PATCH | Обрабатывает данные для указанного шага мастера |
| GET | Возвращает спецификацию действий и полей |
| GET | Возвращает список доступных типов мастеров |
Команды, связанные со списком ВРМ
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список ВРМ |