Команды портала «Агрегатор»

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

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «auth» портала «Агрегатор»).

Таблица 1. Перечень URL-команд модуля «auth» портала «Агрегатор»
URL-команда	Тип	Описание
`/api/auth/v7.0/authenticators`	GET	Возвращает список доменов аутентификации
`/api/auth/v7.0/authenticators/{auth_uuid}/pkinit/finalize`	PATCH	Завершает аутентификацию Kerberos PKINIT
`/api/auth/v7.0/authenticators/{auth_uuid}/pkinit/login`	PATCH	Инициализирует аутентификацию Kerberos PKINIT и получает данные на подпись
`/api/auth/v7.0/authenticators/{auth_uuid}/pkinit/raw`	PATCH	Прямой запрос на сервер Kerberos PKINIT с подписанным сертификатом
`/api/auth/v7.0/jwtauth`	POST	Авторизация «Агрегатора» на «Универсальном диспетчере». В ответ на подписанный «Агрегатором» токен «Универсальный диспетчер» возвращает сеансовый ключ (токен)
`/api/auth/v7.0/legacy/login`	POST	Аутентификация пользователя на базе аутентификатора, логина и пароля. При отправке запроса необходимо обязательно указать один из параметров: «authId»; «auth»; «authSmallName»
`/api/auth/v7.0/legacy/login/2fa`	POST	Двухфакторная аутентификация пользователя на базе аутентификатора, логина и пароля. При отправке запроса необходимо обязательно указать один из параметров: «authId»; «auth»; «authSmallName»
`/api/auth/v7.0/legacy/logout`	POST	Прекращение действие токена/сессии пользователя. Токен аутентификации должен передаваться в заголовке `X-Auth-Token`
`/api/auth/v7.0/settings`	GET	Получение глобальных настроек сервера

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

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «client» портала «Агрегатор»).

Таблица 2. Перечень URL-команд модуля «client» портала «Агрегатор»
URL-команда	Тип	Описание
`/aggregator/api/client/v7.0/{site_uri}/connectionInfo/{id}`	GET	API для выдачи параметров подключения компоненту «Клиент» для протоколов RDP и SPICE от «Универсального диспетчера»
`/aggregator/api/client/v7.0/{site_uri}/preconnectionInfo/{id}`	GET	API для выдачи параметров подключения компоненту «Клиент» для протоколов RDP и SPICE от «Универсального диспетчера». Компонент «Клиент» использует метод для проверки готовности сервиса к подключению и уточнения используемого протокола. По полученным данным принимает решение: завершить неудачное подключение, подождать и повторить, подключаться новым/старым методом
`/aggregator/api/client/v7.0/{site_uri}/reconnect/`	POST	Обновляет ссылку для переподключения к сессии РМ
`/aggregator/api/client/v7.0/{site_uri}/servicesList/`	GET	Получение и сравнение списка доменов аутентификации из базы данных (БД) и от «Универсального диспетчера», а также получение связанного списка сервисов, если получены совпадающие короткие наименования доменов аутентификации (одинаковые метки доменов)

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

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «discover» портала «Агрегатор»).

Таблица 3. Перечень URL-команд модуля «discover» портала «Агрегатор»
URL-команда	Тип	Описание
`/api/discover/`	GET	Возвращает список модулей API, предоставляемых «Агрегатором»

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

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «health» портала «Агрегатор»).

Таблица 4. Перечень URL-команд модуля «health» портала «Агрегатор»
URL-команда	Тип	Описание
`/aggregator/health/check`	GET	Проверка состояния сервера. Собираются общие показатели и набор числовых метрик. Для авторизации при обращении к запросу используется токен, определенный в переменной `HEALTH_CHECK_ACCESS_KEY` конфигурационного файла `/etc/opt/termidesk-vdi/termidesk.conf`. Оценка состояния должна производиться в инициаторе запроса на основе набора правил и пороговых значений с учетом конкретной конфигурации системы. Для разных конфигураций системы один и тот же показатель в абсолютном выражении может соответствовать состоянию и «PASS», и «FAIL». Формат запроса: `curl --insecure -v -s -X 'GET' \ 'https://$\{hostname}:$\{health_port}/aggregator/health/check' \ -H 'accept: application/json' \ -H 'Authorization: Token $\{health_check_access_key}'` где: `--insecure` - отключение проверки валидности сертификатов. Выполнение запроса без использования проверки SSL допустимо только на тестовых стендах. В производственной среде необходимо установить валидные сертификаты; `${hostname}` - сетевой адрес или полное доменное имя узла; `${health_port}` - порт для запросов проверки состояния; `${health_check_access_key}` - токен, определенный в переменной `HEALTH_CHECK_ACCESS_KEY` файла `/etc/opt/termidesk-vdi/termidesk.conf`. Пример возвращаемого списка приведен после таблицы
`/aggregator/health/metrics`	GET	Возвращает список метрик сервера. Для авторизации при обращении к запросу используется токен, определенный в переменной `METRICS_ACCESS_KEY` конфигурационного файла `/etc/opt/termidesk-vdi/termidesk.conf`. Формат запроса: `curl --insecure -v -s -X 'GET' \ 'https://$\{hostname}:$\{health_port}/aggregator/health/metrics' \ -H 'accept: application/json' \ -H 'Authorization: Token $\{metrics_access_key}'` где: `--insecure` - отключение проверки валидности сертификатов. Выполнение запроса без использования проверки SSL допустимо только на тестовых стендах. В производственной среде необходимо установить валидные сертификаты; `${hostname}` - сетевой адрес или полное доменное имя узла; `${health_port}` - порт для запросов проверки состояния; `${metrics_access_key}` - токен, определенный в переменной `METRICS_ACCESS_KEY` файла `/etc/opt/termidesk-vdi/termidesk.conf`. Информацию по всем возвращаемым значениям можно получить в документации библиотеки `psutil` на сайте: https://psutil.readthedocs.io/en/latest. Вид возвращаемого списка метрик приведен после таблицы

Пример возвращаемого списка для /aggregator/health/check:

{"version":"5.1","description":"termidesk-aggregator","status":"pass","checks":
    {
    "celery:connectionTest":
        [{"componentId":"celery(common)","componentType":"component","status":"pass"},
            {"componentId":"celery@test(worker)","componentType":"component","status":"pass"}],
    "database:responseTime":
        [{"componentId":"default","componentType":"datastore","observedValue":0.00040602684020996094,"observedUnit":"s","status":"pass"}],
    "messages_broker:connectionTest":
        [{"componentId":"amqp://termidesk:**@localhost:5672/termidesk","componentType":"component","status":"pass"}],
    "fluentd:connectionTest":[],
    "sites:connectionTest":
        [{"componentId":"site2","componentType":"component","status":"pass"},
            {"componentId":"stal","componentType":"component","status":"pass"},
            {"componentId":"test-site","componentType":"component","status":"pass"},
            {"componentId":"site1-1","componentType":"component","status":"pass"},
            {"componentId":"site99","componentType":"component","status":"pass"}
        ]}
}

Вид возвращаемого списка метрик:

# Версия портала «Агрегатор»
version_info{version="5.1"} 1.0
# Версия ОС
system_info{machine="x86_64",os="Linux 6.1.90-1-generic",version="#astra3+ci20 SMP PREEMPT_DYNAMIC Mon Jul 22 14:15:46 UTC 2024"} 1.0
# Период в секундах, в течение которого система функционирует без проблем
uptime_seconds 66686.97834658623
# Общая загрузка процессора в процентах
cpu_total_percent 4.8
# Общее использование физической памяти в процентах
virtual_memory_total_percent 40.5
# Количество операций чтения с диска
disk_read_count 68201.0
# Количество операций записи на диск
disk_write_count 729848.0
# Число прочитанных с диска байт
disk_read_bytes 2.094142464e+09
# Число записанных на диск байт
disk_write_bytes 7.54249728e+09
# Общий размер физической памяти в байтах
virtual_memory_total_bytes 4.117311488e+09
# Размер доступной физической памяти в байтах
virtual_memory_available_bytes 2.447736832e+09
# Размер используемой физической памяти в байтах
virtual_memory_used_bytes 1.303724032e+09
# Размер свободной физической памяти в байтах
virtual_memory_free_bytes 3.78679296e+08
# Общий размер диска в байтах
disk_total_bytes 1.5742214144e+010
# Используемый размер диска в байтах
disk_used_bytes 1.4512279552e+010
# Свободный размер диска в байтах
disk_free_bytes 4.07957504e+08
# Количество авторизованных пользователей в портале «Агрегатор пользователя»
user_session_count 1.0
# Количество авторизованных администраторов в портале «Агрегатор администратора»
admin_session_count 11.0
# Количество доменов аутентификации
auth_domain_count 4.0
# Количество ферм поставщиков ресурсов
# TYPE farms_count gauge
farms_count 4.0
# Количество узлов
servers_count 4.0
# Количество сайтов
sites_count 4.0

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

Доступные администратору URL-команды перечислены в таблице (см. таблицу Перечень URL-команд модуля «userinfo» портала «Агрегатор»).

Таблица 5. Перечень URL-команд модуля «userinfo» портала «Агрегатор»
URL-команда	Тип	Описание
`/api/userinfo/themes`	GET	Получение параметров брендирования
`/api/userinfo/themes`	PUT	Обновление параметров брендирования
`/api/userinfo`	GET	Получение информации о пользователе

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

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

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

Таблица 6. Перечень URL-команд, связанных с объектами инфраструктуры портала «Агрегатор»
URL-команда	Тип	Описание
`/api/webui/aggregator/appnodes/portals`	GET	Возвращает список объектов инфраструктуры («Порталов»)
`/api/webui/aggregator/appnodes/portals/{uuid}`	DELETE	Удаляет объект инфраструктуры («Порталов»)
`/api/webui/aggregator/appnodes/portals/{uuid}/metrics`	PATCH	Возвращает список метрик объектов инфраструктуры («Порталов»)
`/api/webui/aggregator/appnodes/portals/{uuid}/tags`	PATCH	Возвращает список тегов объектов инфраструктуры («Порталов»)
`/api/webui/aggregator/appnodes/portals/export`	GET	Формирует файл экспорта объектов инфраструктуры («Порталов»)
`/api/webui/aggregator/appnodes/portals/export`	POST	Получает файл экспорта объектов инфраструктуры («Порталов»)

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

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

Таблица 7. Перечень URL-команд, связанных с событиями аудита портала «Агрегатор»
URL-команда	Тип	Описание
`/api/webui/aggregator/audit`	GET	Возвращает список событий аудита
`/api/webui/aggregator/audit/export`	GET	Формирует файл экспорта событий аудита
`/api/webui/aggregator/audit/export`	POST	Получает файл экспорта событий аудита

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

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

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

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

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

Таблица 9. Перечень URL-команд, связанных с панелью мониторинга портала «Агрегатор»
URL-команда	Тип	Описание
`/api/webui/aggregator/node-info`	GET	Возвращает информацию о сервере

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

Таблица 10. Перечень URL-команд, связанных с панелью мониторинга портала «Агрегатор»
URL-команда	Тип	Описание
`/api/webui/aggregator/dashboard/admin`	GET	Просмотр списка объектов панели мониторинга для «Агрегатора администратора»
`/api/webui/aggregator/dashboard/user/{site_uri}`	GET	Просмотр списка объектов панели мониторинга для «Агрегатора пользователя»

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

«Агрегатор»

Доступные администратору URL-команды перечислены в таблице (см. таблицу [ПереченьURLкомандсвязанныхсузламиУниверсальногодиспетчерапорталаАгрегато]).

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

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

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

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

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

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

Таблица 13. Перечень URL-команд, связанных с изображением портала «Агрегатор»
URL-команда	Тип	Описание
`/api/webui/aggregator/gallery/images/srvimg/{image_id}`	GET	Возвращает изображение по идентификатору, либо для протокола доставки, либо установленное по умолчанию
`/api/webui/aggregator/gallery/images/transicon/{image_id}`	GET	Возвращает изображение для протокола доставки

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

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

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

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

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

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

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

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

Таблица 16. Перечень URL-команд, связанных с функциями мониторинга портала «Агрегатор»
URL-команда	Тип	Описание
`/api/webui/aggregator/monitoring`	GET	Просмотр всех записей журнала в виде списка
`/api/webui/aggregator/monitoring`	POST	Добавляет запись в журнал
`/api/webui/aggregator/monitoring/{id}`	GET	Просмотр записи журнала с идентификатором `{id}`
`/api/webui/aggregator/monitoring/{id}`	PUT	Обновляет запись журнала с идентификатором `{id}`
`/api/webui/aggregator/monitoring/{id}`	PATCH	Обновляет запись журнала с идентификатором `{id}`
`/api/webui/aggregator/monitoring/{id}`	DELETE	Удаляет запись журнала с идентификатором `{id}`
`/api/webui/aggregator/monitoring/bulk_destroy`	PATCH	Удаляет все записи журнала
`/api/webui/aggregator/monitoring/export`	GET	Формирует файл экспорта событий журнала
`/api/webui/aggregator/monitoring/export`	POST	Получает файл экспорта событий журнала

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

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

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

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

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

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

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

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

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

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

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

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

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

Доступные администратору URL-команды перечислены в таблице (см. таблицу [ПереченьURLкомандсвязанныхссайтамипорталаАгрегато]).

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

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

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

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

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

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

Таблица 23. Перечень URL-команд, связанных с тегами
URL-команда	Тип	Описание
`/api/webui/aggregator/tags`	GET	Возвращает список тегов
`/api/webui/aggregator/tags`	POST	Создает тег
`/api/webui/aggregator/tags/{id}`	GET	Возвращает тег
`/api/webui/aggregator/tags/{id}`	PUT	Обновляет тег
`/api/webui/aggregator/tags/{id}`	PATCH	Управляет тегами
`/api/webui/aggregator/tags/{id}`	DELETE	Удаляет тег
`/api/webui/aggregator/tags/export`	GET	Формирует файл экспорта тегов
`/api/webui/aggregator/tags/export`	POST	Получает файл экспорта тегов

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

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

Таблица 24. Перечень URL-команд, связанных с системными параметрами портала «Агрегатор»
URL-команда	Тип	Описание
`/api/webui/aggregator/tconfig`	GET	Возвращает список системных параметров
`/api/webui/aggregator/tconfig`	PUT	Сохраняет параметры конфигурации

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

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

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