.REST API. Доступные команды модуля «webui» портала «Агрегатор» v6.1

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

Команды, связанные с администрированием портала «Агрегатор»

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/admin/authenticators/{id}/add_group/`	POST	Добавляет группу домена аутентификации
`/aggregator/api/webui/admin/authenticators/{id}/add_user/`	POST	Добавляет пользователя группы домена аутентификации
`/aggregator/api/webui/admin/authenticators/detail/{id}/`	GET	Возвращает сведения о домене аутентификации

Команды, связанные с событиями аудита портала «Агрегатор»

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/audit`	GET	Возвращает список событий аудита

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

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/authenticators`	GET	Возвращает список доменов аутентификации, добавленных на портал «Агрегатор»
`/aggregator/api/webui/authenticators`	POST	Создает домен аутентификации
`/aggregator/api/webui/authenticators/{auth_uuid}/groups`	GET	Возвращает список групп домена аутентификации
`/aggregator/api/webui/authenticators/{auth_uuid}/groups`	POST	Создает группу домена аутентификации
`/aggregator/api/webui/authenticators/{auth_uuid}/groups/{uuid}`	GET	Возвращает группу с идентификатором `{uuid}` домена аутентификации с идентификатором `{auth_uuid}`
`/aggregator/api/webui/authenticators/{auth_uuid}/groups/{uuid}`	PUT	Обновляет группу с идентификатором `{uuid}` домена аутентификации с идентификатором `{auth_uuid}`
`/aggregator/api/webui/authenticators/{auth_uuid}/groups/{uuid}`	PATCH	Обновляет группу с идентификатором `{uuid}` домена аутентификации с идентификатором `{auth_uuid}`
`/aggregator/api/webui/authenticators/{auth_uuid}/groups/{uuid}`	DELETE	Удаляет группу с идентификатором `{uuid}` домена аутентификации с идентификатором `{auth_uuid}`
`/aggregator/api/webui/authenticators/{auth_uuid}/groups/bulk_destroy`	POST	Удаляет все группы домена аутентификации с идентификатором `{auth_uuid}`
`/aggregator/api/webui/authenticators/{auth_uuid}/groups/external`	GET	Возвращает список групп из службы каталогов для домена аутентификации с идентификатором `{auth_uuid}`
`/aggregator/api/webui/authenticators/{auth_uuid}/users`	GET	Возвращает список пользователей домена аутентификации
`/aggregator/api/webui/authenticators/{auth_uuid}/users`	POST	Создает пользователя домена аутентификации
`/aggregator/api/webui/authenticators/{auth_uuid}/users/{uuid}`	GET	Возвращает пользователя с идентификатором `{uuid}` домена аутентификации с идентификатором `{auth_uuid}`
`/aggregator/api/webui/authenticators/{auth_uuid}/users/{uuid}`	PUT	Обновляет пользователя с идентификатором `{uuid}` домена аутентификации с идентификатором `{auth_uuid}`
`/aggregator/api/webui/authenticators/{auth_uuid}/users/{uuid}`	PATCH	Обновляет пользователя с идентификатором `{uuid}` домена аутентификации с идентификатором `{auth_uuid}`
`/aggregator/api/webui/authenticators/{auth_uuid}/users/{uuid}`	DELETE	Удаляет пользователя с идентификатором `{uuid}` домена аутентификации с идентификатором `{auth_uuid}`
`/aggregator/api/webui/authenticators/{auth_uuid}/users/bulk_destroy`	POST	Удаляет всех пользователей домена аутентификации с идентификатором `{auth_uuid}`
`/aggregator/api/webui/authenticators/{uuid}`	GET	Возвращает домен аутентификации с идентификатором `{uuid}`
`/aggregator/api/webui/authenticators/{uuid}`	PUT	Обновляет домен аутентификации с идентификатором `{uuid}`
`/aggregator/api/webui/authenticators/{uuid}`	PATCH	Обновляет домен аутентификации с идентификатором `{uuid}`
`/aggregator/api/webui/authenticators/{uuid}`	DELETE	Удаляет домен аутентификации с идентификатором `{uuid}`
`/aggregator/api/webui/authenticators/{uuid}/log`	GET	Возвращает журнал домена аутентификации с идентификатором `{uuid}`
`/aggregator/api/webui/authenticators/bulk_destroy`	POST	Удаляет домены аутентификации
`/aggregator/api/webui/authenticators/gui/{data_type}`	GET	Возвращает описание для графического интерфейса домена аутентификации с типом `{data_type}`
`/aggregator/api/webui/authenticators/test_params/{type}`	POST	Тестирует параметры домена аутентификации
`/aggregator/api/webui/authenticators/test/{type}`	POST	Тестирует параметры домена аутентификации
`/aggregator/api/webui/authenticators/types`	GET	Возвращает список доступных типов доменов аутентификации

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

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/dashboard`	GET	Просмотр списка объектов панели мониторинга

Команды, связанные с узлами «Универсального диспетчера» портала «Агрегатор»

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/dispatchers`	GET	Возвращает список узлов «Универсального диспетчера», добавленных на портал «Агрегатор»
`/aggregator/api/webui/dispatchers`	POST	Добавляет узел «Универсального диспетчера»
`/aggregator/api/webui/dispatchers/{id}`	GET	Возвращает узел «Универсального диспетчера» с идентификатором `{id}`
`/aggregator/api/webui/dispatchers/{id}`	PUT	Обновляет узел «Универсального диспетчера» с идентификатором `{id}`
`/aggregator/api/webui/dispatchers/{id}`	PATCH	Обновляет узел «Универсального диспетчера» с идентификатором `{id}`
`/aggregator/api/webui/dispatchers/{id}`	DELETE	Удаляет узел «Универсального диспетчера» с идентификатором `{id}`
`/aggregator/api/webui/dispatchers/bulk_destroy`	POST	Удаляет все узлы «Универсального диспетчера»

Команды, связанные с фермами поставщиков ресурсов портала «Агрегатор»

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/farms`	GET	Возвращает список ферм поставщиков ресурсов, добавленных на портал «Агрегатор»
`/aggregator/api/webui/farms`	POST	Создает ферму поставщиков ресурсов
`/aggregator/api/webui/farms/{id}`	GET	Возвращает ферму поставщиков ресурсов с идентификатором `{id}`
`/aggregator/api/webui/farms/{id}`	PUT	Обновляет ферму поставщиков ресурсов с идентификатором `{id}`
`/aggregator/api/webui/farms/{id}`	PATCH	Обновляет ферму поставщиков ресурсов с идентификатором `{id}`
`/aggregator/api/webui/farms/{id}`	DELETE	Удаляет ферму поставщиков ресурсов с идентификатором `{id}`
`/aggregator/api/webui/farms/{id}/dispatchers`	GET	Возвращает список узлов «Универсального диспетчера» для фермы с идентификатором `{id}`
`/aggregator/api/webui/farms/bulk_destroy`	POST	Удаляет все фермы поставщиков ресурсов

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

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/gateways`	GET	Возвращает список объектов («Шлюзов»), добавленных на портал «Агрегатор»
`/aggregator/api/webui/gateways`	POST	Создает объект («Шлюз»)
`/aggregator/api/webui/gateways/{id}`	GET	Возвращает объект («Шлюз») с идентификатором `{id}`
`/aggregator/api/webui/gateways/{id}`	PUT	Обновляет объект («Шлюз») с идентификатором `{id}`
`/aggregator/api/webui/gateways/{id}`	PATCH	Обновляет объект («Шлюз») с идентификатором `{id}`
`/aggregator/api/webui/gateways/{id}`	DELETE	Удаляет объект («Шлюз») с идентификатором `{id}`
`/aggregator/api/webui/gateways/bulk_destroy`	POST	Удаляет все объекты («Шлюзы»)

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

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/maintenance`	GET	Возвращает список шаблонов техобслуживания, добавленных на портал «Агрегатор»
`/aggregator/api/webui/maintenance`	POST	Создает шаблон техобслуживания
`/aggregator/api/webui/maintenance/{id}`	GET	Возвращает шаблон техобслуживания с идентификатором `{id}`
`/aggregator/api/webui/maintenance/{id}`	PUT	Обновляет шаблон техобслуживания с идентификатором `{id}`
`/aggregator/api/webui/maintenance/{id}`	PATCH	Обновляет шаблон техобслуживания с идентификатором `{id}`
`/aggregator/api/webui/maintenance/{id}`	DELETE	Удаляет шаблон техобслуживания с идентификатором `{id}`
`/aggregator/api/webui/maintenance/bulk_destroy`	POST	Удаляет шаблоны техобслуживания

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

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/monitoring`	GET	Просмотр всех записей журнала в виде списка
`/aggregator/api/webui/monitoring`	POST	Добавляет запись в журнал
`/aggregator/api/webui/monitoring/{id}`	GET	Просмотр записи журнала с идентификатором `{id}`
`/aggregator/api/webui/monitoring/{id}`	PUT	Обновляет запись журнала с идентификатором `{id}`
`/aggregator/api/webui/monitoring/{id}`	PATCH	Обновляет запись журнала с идентификатором `{id}`
`/aggregator/api/webui/monitoring/{id}`	DELETE	Удаляет запись журнала с идентификатором `{id}`
`/aggregator/api/webui/monitoring/bulk_destroy`	POST	Удаляет все записи журнала

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

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/priority_groups`	GET	Возвращает список групп, добавленных на портал «Агрегатор»
`/aggregator/api/webui/priority_groups`	POST	Создает группу
`/aggregator/api/webui/priority_groups/{id}`	GET	Возвращает группу с идентификатором `{id}`
`/aggregator/api/webui/priority_groups/{id}`	PUT	Обновляет группу с идентификатором `{id}`
`/aggregator/api/webui/priority_groups/{id}`	PATCH	Обновляет группу с идентификатором `{id}`
`/aggregator/api/webui/priority_groups/{id}`	DELETE	Удаляет группу с идентификатором `{id}`

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

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

Перечень URL-команд, связанных с управлением полномочиями (ролями) портала «Агрегатор»

URL-команда	Тип	Описание
`/aggregator/api/webui/rbac`	GET	Возвращает список ролей, добавленных на портал «Агрегатор»
`/aggregator/api/webui/rbac`	POST	Создает роль
`/aggregator/api/webui/rbac/{id}`	GET	Возвращает роль с идентификатором `{id}`
`/aggregator/api/webui/rbac/{id}`	PUT	Обновляет роль с идентификатором `{id}`
`/aggregator/api/webui/rbac/{id}`	PATCH	Обновляет роль с идентификатором `{id}`
`/aggregator/api/webui/rbac/{id}`	DELETE	Удаляет роль с идентификатором `{id}`
`/aggregator/api/webui/rbac/permissions`	GET	Возвращает список доступных пользовательских разрешений

Команды, связанные с объединенными наборами ресурсов сайтов портала «Агрегатор»

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/rules`	GET	Возвращает список объединенных наборов ресурсов, добавленных на портал «Агрегатор»
`/aggregator/api/webui/rules`	POST	Добавляет объединенный набор ресурсов
`/aggregator/api/webui/rules/{id}`	GET	Возвращает объединенный набор ресурсов с идентификатором `{id}`
`/aggregator/api/webui/rules/{id}`	PUT	Обновляет объединенный набор ресурсов с идентификатором `{id}`
`/aggregator/api/webui/rules/{id}`	PATCH	Обновляет объединенный набор ресурсов с идентификатором `{id}`
`/aggregator/api/webui/rules/{id}`	DELETE	Удаляет объединенный набор ресурсов с идентификатором `{id}`
`/aggregator/api/webui/rules/bulk_destroy`	POST	Удаляет объединенные наборы ресурсов

Команды, связанные с фондами РМ портала «Агрегатор»

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

Перечень URL-команд, связанных с фондами РМ портала «Агрегатор»

URL-команда	Тип	Описание
`/aggregator/api/webui/servicespools`	GET	Возвращает список фондов РМ, добавленных на портал «Агрегатор»
`/aggregator/api/webui/servicespools/{id}/maintenance/{servicepool_uuid}`	PATCH	Управляет режимом техобслуживания фонда РМ
`/aggregator/api/webui/servicespools/{id}/update/{servicepool_uuid}`	PUT	Обновляет фонд РМ
`/aggregator/api/webui/servicespools/{service_pool_uuid}/policies`	GET	Возвращает список политик для фонда РМ с идентификатором `{service_pool_uuid}`, полученного от «Универсального диспетчера»

Команды, связанные с сайтами портала «Агрегатор»

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/sites`	GET	Возвращает список сайтов, добавленных на портал «Агрегатор»
`/aggregator/api/webui/sites`	POST	Добавляет сайт
`/aggregator/api/webui/sites/{id}`	GET	Возвращает сайт с идентификатором `{id}`
`/aggregator/api/webui/sites/{id}`	PUT	Обновляет сайт с идентификатором `{id}`
`/aggregator/api/webui/sites/{id}`	PATCH	Обновляет сайт с идентификатором `{id}`
`/aggregator/api/webui/sites/{id}`	DELETE	Удаляет сайт с идентификатором `{id}`
`/aggregator/api/webui/sites/{id}/farms`	GET	Способ предоставления всех ферм сайта с идентификатором `{id}`
`/aggregator/api/webui/sites/{id}/rules`	GET	Способ предоставления всех правил (объединенных наборов ресурсов) сайта с идентификатором `{id}`
`/aggregator/api/webui/sites/bulk_destroy`	POST	Удаляет все сайты

Команды, связанные с сессиями пользователей РМ портала «Агрегатор»

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/spsessions`	GET	Возвращает список активных сессий пользователей РМ
`/aggregator/api/webui/spsessions/{id}/disconnect/{session_uuid}`	PATCH	Отключает активную сессию пользователя РМ
`/aggregator/api/webui/spsessions/{id}/logoff/{session_uuid}`	PATCH	Завершает активную сессию пользователя РМ
`/aggregator/api/webui/spsessions/{id}/raconnect/{session_uuid}`	PATCH	Генерация уникального URL для подключения к «Удаленному помощнику»

Команды, связанные с управлением РМ портала «Агрегатор»

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

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

URL-команда	Тип	Описание
`/aggregator/api/webui/workplaces`	GET	Возвращает список РМ
`/aggregator/api/webui/workplaces/{id}/assign/{servicespool_uuid}/{workplace_uuid}`	PATCH	Назначает владельца РМ
`/aggregator/api/webui/workplaces/{id}/delete/{servicespool_uuid}/{workplace_uuid}`	DELETE	Удаляет РМ
`/aggregator/api/webui/workplaces/{id}/machine/{servicespool_uuid}/{workplace_uuid}`	PATCH	Управление состоянием РМ (ВМ)
`/aggregator/api/webui/workplaces/{id}/maintenance/{servicespool_uuid}/{workplace_uuid}`	PATCH	Управление режимом техобслуживания РМ
`/aggregator/api/webui/workplaces/{id}/message/{servicespool_uuid}`	POST	Отправляет сообщение в РМ
`/aggregator/api/webui/workplaces/{id}/refresh/{servicespool_uuid}/{workplace_uuid}`	PATCH	Возвращает ВМ на базовый снапшот

Дерево страниц

.REST API. Доступные команды модуля «webui» портала «Агрегатор» v6.1

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

Команды, связанные с администрированием портала «Агрегатор»

Команды, связанные с событиями аудита портала «Агрегатор»

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

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

Команды, связанные с узлами «Универсального диспетчера» портала «Агрегатор»

Команды, связанные с фермами поставщиков ресурсов портала «Агрегатор»

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

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

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

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

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

Команды, связанные с объединенными наборами ресурсов сайтов портала «Агрегатор»

Команды, связанные с фондами РМ портала «Агрегатор»

Команды, связанные с сайтами портала «Агрегатор»

Команды, связанные с сессиями пользователей РМ портала «Агрегатор»

Команды, связанные с управлением РМ портала «Агрегатор»