Доступные команды модуля «webui»

Команды, связанные со списками устройств доступа

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных со списками устройств доступа

URL-командаТипОписание

/api/webui/draft/access-devices

GETВозвращает список устройств доступа

/api/webui/draft/access-devices/{uuid}

GETВозвращает устройство доступа с идентификатором {uuid}
/api/webui/draft/access-devices/{uuid}/{status} PATCHИзменяет статус устройства доступа с идентификатором {uuid}

Команды, связанные со списками доступа

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных со списками доступа

URL-командаТипОписание

/api/webui/draft/acl

GETВозвращает список объектных разрешений

/api/webui/draft/acl

POSTОбновляет объектное разрешение
/api/webui/draft/acl/{ID} GETВозвращает объектное разрешение с идентификатором {ID}

/api/webui/draft/acl/{ID}

PUTОбновляет объектное разрешение с идентификатором {ID}

/api/webui/draft/acl/{ID}

DELETEУдаляет объектное разрешение с идентификатором {ID}

/api/webui/draft/acl/gui/{data_type}

GETВозвращает описание для графического интерфейса

/api/webui/draft/acl/permissions/{data_type}

GETВозвращает список разрешений для переданного типа объекта

/api/webui/draft/acl/types

GETВозвращает список доступных типов объектных разрешений

Команды, связанные с объектами инфраструктуры

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с объектами инфраструктуры

URL-командаТипОписание

/api/webui/draft/appnodes/brokers

GET

Возвращает список объектов инфраструктуры («Универсальных диспетчеров»)

/api/webui/draft/appnodes/brokers/{uuid}

DELETEУдаляет объект инфраструктуры («Универсальный диспетчер») с идентификатором {uuid}

/api/webui/draft/appnodes/gateways

GET

Возвращает список объектов инфраструктуры («Шлюзов»)

/api/webui/draft/appnodes/gateways/{uuid}

DELETEУдаляет объект инфраструктуры («Шлюз») с идентификатором {uuid}

/api/webui/draft/appnodes/portals

GET

Возвращает список объектов инфраструктуры (порталов)

/api/webui/draft/appnodes/portals/{uuid}

DELETEУдаляет объект инфраструктуры (портал) с идентификатором {uuid}

/api/webui/draft/appnodes/vmcontrollers

GET

Возвращает список объектов инфраструктуры («Менеджеров рабочих мест»)

/api/webui/draft/appnodes/vmcontrollers/{uuid}

DELETEУдаляет объект инфраструктуры («Менеджер рабочих мест») с идентификатором {uuid}

Команды, связанные с журналами событий

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с журналами событий

URL-командаТипОписание

/api/webui/draft/audit/events

GET

Возвращает список событий аудита 

/api/webui/draft/audit/events/types

GETВозвращает список доступных типов событий аудита

Команды, связанные с доменами аутентификации

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с доменами аутентификации

URL-командаТипОписание

/api/webui/draft/authenticators

GETВозвращает список доменов аутентификации

/api/webui/draft/authenticators

POSTСоздает домен аутентификации

/api/webui/draft/authenticators/{auth_uuid}/groups

GETВозвращает список групп домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/groups

POSTСоздает группу домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/groups/{uuid}

GETВозвращает группу с идентификатором {uuid} домена аутентификации  с идентификатором {auth_uuid}

/api/webui/draft/authenticators/{auth_uuid}/groups/{uuid}

PUTОбновляет группу домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/groups/{uuid}

DELETEУдаляет группу домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/groups/{uuid}/servicesPools

GETВозвращает список ВРМ группы домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/groups/{uuid}/users

GETВозвращает список пользователей группы домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/groups/external

GETВозвращает список доступных групп для домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/groups/types

GETВозвращает список доступных типов групп домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/groups/gui/{group_type}

GETВозвращает описание для графического интерфейса группы с типом {group_type}

/api/webui/draft/authenticators/{auth_uuid}/users

GETВозвращает список пользователей домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/users

POSTСоздает пользователя домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/users/{uuid}

GETВозвращает пользователя с идентификатором  {uuid} домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/users/{uuid}

PUTОбновляет пользователя домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/users/{uuid}

DELETEУдаляет пользователя домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/users/{uuid}/log

GETВозвращает журнал пользователя домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/users/{uuid}/servicesPools

GETВозвращает список ВРМ пользователя домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/users/{uuid}/userServices

GETВозвращает список ассоциированных виртуальных машин для пользователя домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/users/external

GETВозвращает список доступных пользователей для домена аутентификации

/api/webui/draft/authenticators/{auth_uuid}/users/gui

GETВозвращает описание для графического интерфейса

/api/webui/draft/authenticators/{auth_uuid}/users/types

GETВозвращает список доступных типов пользователей домена аутентификации

/api/webui/draft/authenticators/{uuid}

GETВозвращает домен аутентификации 

/api/webui/draft/authenticators/{uuid}

PUTОбновляет домен аутентификации 

/api/webui/draft/authenticators/{uuid}

DELETEУдаляет домен аутентификации 

/api/webui/draft/authenticators/{uuid}/log

GETВозвращает журнал домена аутентификации

/api/webui/draft/authenticators/types

GETВозвращает список доступных типов доменов аутентификации

/api/webui/draft/authenticators/gui/{data_type}

GETВозвращает описание для графического интерфейса домена аутентификации с типом {data_type}

/api/webui/draft/authenticators/test/{type}

POSTТестирует параметры домена аутентификации

Команды, связанные с панелью мониторинга

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с панелью мониторинга

URL-командаТипОписание

/api/webui/draft/dashboard

GETПросмотр списка объектов панели мониторинга

Команды, связанные с изображениями гостевых ОС

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с изображением гостевых ОС

URL-командаТипОписание

/api/webui/draft/gallery/images

GETВозвращает список изображений

/api/webui/draft/gallery/images

POSTСоздает изображение

/api/webui/draft/gallery/images/{uuid}

GETВозвращает изображение с идентификатором {uuid}

/api/webui/draft/gallery/images/{uuid}

PUTОбновляет изображение

/api/webui/draft/gallery/images/{uuid}

DELETEУдаляет изображение

/api/webui/draft/gallery/images/gui

GETВозвращает описание для графического интерфейса

Команды, связанные с графическим интерфейсом

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с вызовом функций графического интерфейса

URL-командаТипОписание

/api/webui/draft/gui/callback/{callback}

GETДоступ к callback-функциям графического интерфейса

Команды, связанные с получением индекса

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с получением индекса

URL-командаТипОписание

/api/webui/draft

GETОпределяет текущую версию REST API

Команды, связанные с функциями мониторинга

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с функциями мониторинга

URL-командаТипОписание

/api/webui/draft/monitoring

GETПросмотр всех журналов в виде списка

Команды, связанные с аутентификацией на основе адресов сети

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с IP-аутентификацией

URL-командаТипОписание

/api/webui/draft/networks

GETВозвращает список сетей

/api/webui/draft/networks

POSTСоздает сеть

/api/webui/draft/networks/{uuid}

GETВозвращает сеть с идентификатором {uuid}

/api/webui/draft/networks/{uuid}

PUTОбновляет сеть

/api/webui/draft/networks/{uuid}

DELETEУдаляет сеть

/api/webui/draft/networks/gui

GETВозвращает описание для графического интерфейса

Команды, связанные с параметрами гостевых ОС

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с параметрами гостевых ОС

URL-командаТипОписание

/api/webui/draft/osmanagers

GETВозвращает список параметров гостевых ОС

/api/webui/draft/osmanagers

POSTСоздает параметры гостевых ОС

/api/webui/draft/osmanagers/{uuid}

GETВозвращает параметры гостевых ОС с идентификатором {uuid}

/api/webui/draft/osmanagers/{uuid}

PUTОбновляет параметры гостевых ОС

/api/webui/draft/osmanagers/{uuid}

DELETEУдаляет параметры гостевых ОС

/api/webui/draft/osmanagers/types

GETВозвращает список типов параметров гостевых ОС

/api/webui/draft/osmanagers/gui/{data_type}

GETВозвращает описание для графического интерфейса для параметров с типом {data_type}

Команды, связанные с глобальными политиками

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с глобальными политиками

URL-командаТипОписание

/api/webui/draft/policies

GETСписок всех доступных политик

/api/webui/draft/policies/{uuid}

GETПолучить информацию о политике с типом {data_type}

/api/webui/draft/policies/{uuid}

PUTОбновить параметры политики

/api/webui/draft/policies/{uuid}

DELETEСброс глобальной политики

/api/webui/draft/policies/gui/{policy_type}

GETСпецификация полей графического интерфейса для политики конкретного типа

Команды, связанные с поставщиками ресурсов

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с поставщиками ресурсов

URL-командаТипОписание

/api/webui/draft/providers

GETВозвращает список поставщиков ресурсов

/api/webui/draft/providers

POSTСоздает поставщика ресурсов

/api/webui/draft/providers/{uuid}

GETВозвращает поставщик ресурсов с идентификатором {uuid}

/api/webui/draft/providers/{uuid}

PUTОбновляет поставщик ресурсов

/api/webui/draft/providers/{uuid}

DELETEУдаляет поставщик ресурсов

/api/webui/draft/providers/{uuid}/maintenance

PATCHПереводит поставщик ресурсов в режим техобсуживания

/api/webui/draft/providers/types

GETВозвращает список доступных типов поставщиков техобслуживания

/api/webui/draft/providers/test/{prov_type}

POSTТестирует параметры поставщика ресурсов

/api/webui/draft/providers/gui/{prov_type}

GETВозвращает описание для графического интерфейса

/api/webui/draft/providers/{provider_uuid}/services

GETВозвращает список шаблонов ВРМ поставщика ресурсов

/api/webui/draft/providers/{provider_uuid}/services

POSTСоздает шаблон ВРМ

/api/webui/draft/providers/{provider_uuid}/services/{uuid}

GETВозвращает шаблон ВРМ с идентификатором {uuid} поставщика ресурсов 

/api/webui/draft/providers/{provider_uuid}/services/{uuid}

PUTОбновляет шаблон ВРМ с идентификатором {uuid} поставщика ресурсов

/api/webui/draft/providers/{provider_uuid}/services/{uuid}

DELETEУдаляет шаблон ВРМ с идентификатором {uuid} поставщика ресурсов

/api/webui/draft/providers/{provider_uuid}/services/types

GETВозвращает список доступных типов шаблонов ВРМ поставщика ресурсов

/api/webui/draft/providers/{provider_uuid}/services/gui/{service_type}

GETВозвращает описание для графического интерфейса для шаблона ВРМ с типом {service_type} поставщика ресурсов 

Команды, связанные с управлением полномочиями (ролями)

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с управлением ролями

URL-командаТипОписание

/api/webui/draft/rbac

GETВозвращает список ролей

/api/webui/draft/rbac

POSTСоздает роль

/api/webui/draft/rbac/{id}

GETВозвращает роль

/api/webui/draft/rbac/{id}

PUTОбновляет роль 

/api/webui/draft/rbac/{id}

DELETEУдаляет роль 

/api/webui/draft/rbac/gui

GETВозвращает описание для графического интерфейса

/api/webui/draft/rbac/permissions

GETВозвращает список разрешений для ролей

Команды, связанные с отчетами

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с отчетами

URL-командаТипОписание

/api/webui/draft/reports

GETВозвращает список отчетов

/api/webui/draft/reports

POSTСоздает отчет

/api/webui/draft/reports/{id}

GETВозвращает отчет

/api/webui/draft/reports/{id}

PUTОбновляет отчет

/api/webui/draft/reports/{id}

DELETEУдаляет отчет

/api/webui/draft/reports/{id}/generate

GETГенерирует отчет с идентификатором {id}

/api/webui/draft/reports/gui/{data_type}

GET Возвращает описание для графического интерфейса

/api/webui/draft/reports/types

GET Возвращает список доступных типов отчетов

Команды, связанные с фондами ВРМ

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с фондами ВРМ

URL-командаТипОписание

/api/webui/draft/servicespools

GETВозвращает список фондов ВРМ

/api/webui/draft/servicespools

POSTСоздает фонд ВРМ

/api/webui/draft/servicespools/{uuid}

GETВозвращает фонд ВРМ

/api/webui/draft/servicespools/{uuid}

PUTОбновляет фонд ВРМ

/api/webui/draft/servicespools/{uuid}

DELETEУдаляет фонд ВРМ

/api/webui/draft/servicespools/gui

GETВозвращает описание для графического интерфейса

/api/webui/draft/servicespools/types

GETВозвращает список доступных типов для фондов ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/groups

GETВозвращает список групп фонда ВРМ 

/api/webui/draft/servicespools/{servicespool_uuid}/groups

POSTДобавляет группу в фонд ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/groups/{uuid}

GETНабор операций для управления группой из фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/groups/{uuid}

DELETEУдаляет группу с идентификатором {uuid} из фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/groups/gui

GETВозвращает описание для графического интерфейса

/api/webui/draft/servicespools/{servicespool_uuid}/policies

GETСписок всех политик фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/policies

PUTСоздает  политику фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/policies/{uuid}

GETПолучает информацию о политиках фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/policies/{uuid}

PUTОбновляет  параметры политики фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/policies/{uuid}

DELETEСброс политики фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/policies/gui/{policy_type}

GETСпецификация полей графического интерфейса для политики типа {data_type}

/api/webui/draft/servicespools/{servicespool_uuid}/publications/publish

GETЗапускает процедуру публикации фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/publications

GETВозвращает список публикаций фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/publications/{uuid}

GETВозвращает публикацию с идентификатором {uuid}  

/api/webui/draft/servicespools/{servicespool_uuid}/publications/{uuid}/cancel

GETЗапускает отмену публикации фонда ВРМ. Повторный вызов запускает форсированную отмену публикации фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/publications/gui

GETВозвращает описание для графического интерфейса

/api/webui/draft/servicespools/{servicespool_uuid}/transports

GETВозвращает список протоколов доставки из фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/transports

POSTДобавляет протокол доставки в фонд ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/transports/{uuid}

GETВозвращает протокол доставки с идентификатором {uuid} из фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/transports/{uuid}

DELETEУдаляет протокол доставки с идентификатором {uuid} из фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/transports/gui

GETВозвращает описание для графического интерфейса

/api/webui/draft/servicespools/{servicespool_uuid}/users

GETВозвращает список пользователей фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/users

POSTДобавляет пользователя в фонд ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/users/{uuid}

GETНабор операций для управления пользователями из фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/users/{uuid}

DELETEУдаляет пользователя из фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/users/gui

GETВозвращает описание для графического интерфейса

/api/webui/draft/servicespools/{servicespool_uuid}/cache

GETПолучение списка ВРМ, находящихся в кеше фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/cache/{uuid}

GETВозвращает ВРМ, находящееся в кеше фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/cache/{uuid}

DELETEУдаляет ВРМ, находящееся в кеше из фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/cache/{uuid}/assign

PATCHНазначает пользователю ВРМ, находящееся в кеше

/api/webui/draft/servicespools/{servicespool_uuid}/cache/{uuid}/assign/gui

GETВозвращает описание для графического интерфейса ВРМ, находящегося в кеше

/api/webui/draft/servicespools/{servicespool_uuid}/cache/{uuid}/log

GETВозвращает журнал ВРМ, находящегося в кеше

/api/webui/draft/servicespools/{servicespool_uuid}/cache/{uuid}/maintenance

PATCHУправление режимом техобслуживания ВРМ, находящегося в кеше

/api/webui/draft/servicespools/{uuid}/cache/{service_uuid}/machine

PATCHУправление состоянием выбранного ВРМ, находящегося в кеше

/api/webui/draft/servicespools/{uuid}/log

GETВозвращает журнал фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/services

GETПолучает список назначенных ВРМ из фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/services/{uuid}

GETВозвращает назначенное ВРМ из фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/services/{uuid}

DELETEУдаляет назначенное ВРМ из фонда ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/services/{uuid}/log

GETВозвращает журнал назначенного ВРМ

/api/webui/draft/servicespools/{uuid}/maintenance

PATCHПереводит фонд ВРМ в режим техобслуживания и возвращает из него

/api/webui/draft/servicespools/{uuid}/services/{service_uuid}/machine

PATCHУправление состоянием назначенного ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/services/{uuid}/refresh

PATCHОткат назначенной ВМ на базовый снапшот

/api/webui/draft/servicespools/{servicespool_uuid}/services/{uuid}/replace

PATCHЗамена назначенного экземпляра ВМ на новый (запись в базе данных о ВРМ остается та же)

/api/webui/draft/servicespools/{servicespool_uuid}/services/{uuid}/maintenance

PATCHУправление режимом техобслуживания назначенного ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/services/message

POSTОтправка сообщения назначенным ВРМ

/api/webui/draft/servicespools/{servicespool_uuid}/services/message/gui

GETВозвращает описание для графического интерфейса метода отправки сообщения ВРМ

Команды, связанные с группами ВРМ

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с группами ВРМ

URL-командаТипОписание

/api/webui/draft/spgroups

GETВозвращает список групп

/api/webui/draft/spgroups

POSTСоздает группу

/api/webui/draft/spgroups/{uuid}

GETВозвращает группу с идентификатором {uuid}

/api/webui/draft/spgroups/{uuid}

PUTОбновляет группу

/api/webui/draft/spgroups/{uuid}

DELETEУдаляет группу

/api/webui/draft/spgroups/gui

GETВозвращает описание для графического интерфейса

Команды, связанные с сессиями пользователей

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с сессиями пользователей

URL-командаТипОписание

/api/webui/draft/spsessions

GETВозвращает список активных сессий пользователей

/api/webui/draft/spsessions/{uuid}

GETВозвращает активную сессию пользователя

/api/webui/draft/spsessions/{uuid}/disconnect

PATCHСбрасывает активную сессию пользователя

/api/webui/draft/spsessions/{uuid}/logoff

PATCHОстанавливает активную сессию пользователя

/api/webui/draft/spsessions/{uuid}/raconnect

PATCHГенерация уникального URL для подключения к «Удаленному помощнику»

Команды, связанные с системными параметрами

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с системными параметрами

URL-командаТипОписание

/api/webui/draft/tconfig

GETВозвращает список системных параметров

/api/webui/draft/tconfig

PUTСохранение параметров конфигурации

Команды, связанные с протоколами доставки

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с протоколами доставки

URL-командаТипОписание

/api/webui/draft/transports

GETВозвращает список протоколов доставки

/api/webui/draft/transports

POSTСоздает протокол доставки

/api/webui/draft/transports/{uuid}

GETВозвращает протокол доставки

/api/webui/draft/transports/{uuid}

PUTОбновляет протокол доставки

/api/webui/draft/transports/{uuid}

DELETEУдаляет протокол доставки

/api/webui/draft/transports/types

GETВозвращает список типов протоколов доставки

/api/webui/draft/transports/gui/{transport_type}

GETВозвращает описание для графического интерфейса

/api/webui/draft/transports/test/{transport_type}

POSTТестирует параметры протокола доставки

Команды, связанные с работой мастеров 

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных с работой мастеров

URL-командаТипОписание

/api/webui/draft/wizards

GETВозвращает список мастеров

/api/webui/draft/wizards/{uuid}

DELETEУдаляет мастер с идентификатором {uuid}

/api/webui/draft/wizards/{uuid}/finish

PATCHСоздает объект после валидации собранных данных. Удаляет мастер из временного хранилища

/api/webui/draft/wizards/{uuid}/step/{step}

PATCH Обрабатывает данные для указанного шага мастера

/api/webui/draft/wizards/{uuid}/step/{step}/gui

GET Возвращает спецификацию действий и полей

/api/webui/draft/wizards/types

GET Возвращает список доступных типов мастеров

Команды, связанные со списком ВРМ

Доступные администратору URL-команды перечислены в таблице.

Перечень URL-команд, связанных со списком ВРМ

URL-командаТипОписание

/api/webui/draft/workplaces

GETВозвращает список ВРМ