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 | Возвращает список объектных разрешений |
| GET | Возвращает набор операций для управления объектными разрешениями |
| POST | Обновляет набор операций для управления объектными разрешениями |
| PUT | Обновляет набор операций для управления объектными разрешениями |
| DELETE | Удаляет объектное разрешение |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список разрешений для переданного типа объекта |
| GET | Возвращает список доступных типов объектных разрешений |
Команды, связанные с объектами инфраструктуры
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список объектов инфраструктуры («Универсальных диспетчеров») |
| DELETE | Удаляет объект инфраструктуры («Универсальный диспетчер») с идентификатором {uuid} |
| GET | Возвращает список объектов инфраструктуры («Шлюзов») |
| DELETE | Удаляет объект инфраструктуры («Шлюз») с идентификатором {uuid} |
| GET | Возвращает список объектов инфраструктуры («Порталов») |
| DELETE | Удаляет объект инфраструктуры («Портал») с идентификатором {uuid} |
| GET | Возвращает список объектов инфраструктуры («Менеджеров рабочих мест») |
| DELETE | Удаляет объект инфраструктуры («Менеджер рабочих мест») с идентификатором {uuid} |
| GET | Возвращает список объектов инфраструктуры («Хранилищ журналов») |
| POST | Обновляет список объектов инфраструктуры («Хранилищ журналов») |
| GET | Возвращает объект инфраструктуры («Хранилище журналов») с идентификатором {uuid} |
| PUT | Обновляет объект инфраструктуры («Хранилище журналов») с идентификатором {uuid} |
| DELETE | Удаляет объект инфраструктуры («Хранилище журналов») с идентификатором {uuid} |
| PATCH | Меняет состояние объекта инфраструктуры («Хранилища журналов») с идентификатором {uuid} |
| GET | Возвращает описание для графического интерфейса для объектов инфраструктуры («Хранилищ журналов») |
| GET | Возвращает список объектов инфраструктуры («Ретрансляторов») |
| POST | Обновляет список объектов инфраструктуры («Ретрансляторов») |
| GET | Возвращает объект инфраструктуры («Ретранслятор») с идентификатором {uuid} |
| PUT | Обновляет объект инфраструктуры («Ретранслятор») с идентификатором {uuid} |
| DELETE | Удаляет объект инфраструктуры («Ретранслятор») с идентификатором {uuid} |
| PATCH | Меняет состояние объекта инфраструктуры («Ретранслятора») с идентификатором {uuid} |
| GET | Возвращает описание для графического интерфейса для объектов инфраструктуры («Ретрансляторов») |
Команды, связанные с журналами событий
Доступные администратору 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 | Просмотр всех журналов в виде списка |
Команды, связанные с аутентификацией на основе адресов сети
Доступные администратору 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 | Получает информацию о политике с идентификатором {uuid} |
| PUT | Меняет значение политики с идентификатором {uuid} |
| DELETE | Сбрасывает значение глобальной политики с идентификатором {uuid} |
| GET | Спецификация полей графического интерфейса для политики конкретного типа |
Команды, связанные с поставщиками ресурсов
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список поставщиков ресурсов |
| POST | Создает поставщика ресурсов |
| GET | Возвращает поставщика ресурсов с идентификатором {uuid} |
| PUT | Обновляет поставщика ресурсов |
| DELETE | Удаляет поставщика ресурсов |
| PATCH | Переводит поставщика ресурсов в режим техобсуживания |
| GET | Возвращает список доступных типов поставщиков техобслуживания |
| POST | Тестирует параметры поставщика ресурсов |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список шаблонов РМ поставщика ресурсов |
| POST | Создает шаблон РМ |
| GET | Возвращает шаблон РМ с идентификатором {uuid} поставщика ресурсов |
| PUT | Обновляет шаблон РМ с идентификатором {uuid} поставщика ресурсов |
| DELETE | Удаляет шаблон РМ с идентификатором {uuid} поставщика ресурсов |
| POST | Создает снимок ВМ (снапшот) |
| GET | Возвращает список доступных типов шаблонов РМ поставщика ресурсов |
| GET | Возвращает описание для графического интерфейса для шаблона РМ с типом {service_type} поставщика ресурсов |
Команды, связанные с управлением полномочиями (ролями)
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список ролей |
| POST | Создает роль |
| GET | Возвращает роль |
| PUT | Обновляет роль |
| DELETE | Удаляет роль |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список разрешений для ролей |
Команды, связанные с отчетами
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список отчетов |
| POST | Создает отчет |
| GET | Возвращает отчет с идентификатором {id} |
| PUT | Обновляет отчет с идентификатором {id} |
| DELETE | Удаляет отчет с идентификатором {id} |
| GET | Генерирует отчет с идентификатором {id} |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список доступных типов отчетов |
Команды, связанные с расписаниями
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список расписаний |
| GET | Возвращает расписание с идентификатором {id} |
| PUT | Обновляет расписание с идентификатором {id} |
| DELETE | Удаляет расписание с идентификатором {id} |
| PATCH | Меняет состояние расписания с идентификатором {id} |
Команды, связанные с фондами РМ
Доступные администратору URL-команды перечислены в таблице.
URL-команда | Тип | Описание |
---|---|---|
| GET | Возвращает список фондов РМ |
| POST | Создает фонд РМ |
| GET | Возвращает фонд РМ |
| PUT | Обновляет фонд РМ |
| DELETE | Удаляет фонд РМ |
| GET | Возвращает описание для графического интерфейса |
| GET | Возвращает список доступных типов для фондов РМ |
| GET | Возвращает список групп фонда РМ |
| POST | Добавляет группу в фонд РМ |
| GET | Набор операций для управления группой из фонда РМ |
| DELETE | Удаляет группу с идентификатором {uuid} из фонда РМ |
| GET | Возвращает описание для графического интерфейса |
| GET | Список всех политик фонда РМ |
| POST | Обновляет политику фонда РМ |
| GET | Получает информацию о политике фонда РМ |
| PUT | Обновляет параметры политики фонда РМ |
| DELETE | Сбрасывает политику фонда РМ |
| GET | Спецификация полей графического интерфейса для политики типа {policy_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 | Возвращает активную сессию пользователя. Пример запроса конкретной сессии через утилиту curl:
BASH
где:
|
| 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 | Возвращает список РМ |