24 lines
2.3 KiB
Markdown
24 lines
2.3 KiB
Markdown
|
||
#### Общая информация
|
||
|
||
|
||
Alfa Cloud — серверный API, который предоставляет доступ к управлению контейнерами и конфигурацией облаков Alfa с поддержкой нескольких облачных серверов.
|
||
|
||
Данный документ нужен для разработки полноценного фронтенда управления контейнерами.
|
||
|
||
Все запросы должны производиться только из админки Mol с авторизацией Basic Auth (обычный логин и пароль). Учётные можно менять регулярно, для этого существует специальный запрос. Учётные данные НЕ синхронизированы с основными учётными данными MOL (и для безопасности и отсутствия необходимости синхронизации всех юзеров. Нужен только главный админ).
|
||
|
||
В данном API в тестовом режиме будет использоваться спецификация JSON:API для унификации серверных ответов
|
||
#### Точки подключения
|
||
|
||
GET:
|
||
/servers — получить список активных серверов (для разворачивания новых клиентов)
|
||
/servers/{id} — получить подробную информацию о сервере <span style="color: gray">(с параметрами мониторинга (<b>позже</b>))</span>
|
||
/clients — получить список контейнеров клиентов со всеми подробностями (поддерживается пагинация)
|
||
|
||
POST:
|
||
/servers/create — создать сервер в БД
|
||
/servers/{id}/edit — изменить информацию о сервере
|
||
/clients/create — создать клиента
|
||
/clients/{id}/edit — редактировать данные клиента (кроме пароля администратора лабы)
|
||
/clients/{id}/owner_password — задать новый пароль администратора лаборатории |