vault backup: 2025-02-28 23:45:42
This commit is contained in:
@@ -5,7 +5,7 @@ Alfa Cloud — серверный API, который предоставляет
|
|||||||
|
|
||||||
Данный документ нужен для разработки полноценного фронтенда управления контейнерами.
|
Данный документ нужен для разработки полноценного фронтенда управления контейнерами.
|
||||||
|
|
||||||
Все запросы должны производиться только из админки Mol с авторизацией Basic Auth (обычный логин и пароль). Учётные данные можно менять регулярно, для этого существует специальный запрос. Учётные данные НЕ синхронизированы с основными учётными данными MOL (и для безопасности и отсутствия необходимости синхронизации всех юзеров. Нужен только главный админ).
|
Все запросы должны производиться только из админки Mol. Метод авторизации каждого запроса - Basic Auth (обычный логин и пароль). Учётные данные можно менять регулярно, для этого существует специальный запрос. Учётные данные НЕ синхронизированы с основными учётными данными MOL (и для безопасности и отсутствия необходимости синхронизации всех юзеров. Нужен только главный админ).
|
||||||
|
|
||||||
В данном API в тестовом режиме будет использоваться спецификация JSON:API для унификации серверных ответов.
|
В данном API в тестовом режиме будет использоваться спецификация JSON:API для унификации серверных ответов.
|
||||||
#### Точки подключения:
|
#### Точки подключения:
|
||||||
@@ -18,11 +18,14 @@ GET:
|
|||||||
/clients — получить список контейнеров клиентов со всеми подробностями (поддерживается пагинация). С флагом доступностью контейнера. На фронте можно сделать прямой переход на облако клиента.
|
/clients — получить список контейнеров клиентов со всеми подробностями (поддерживается пагинация). С флагом доступностью контейнера. На фронте можно сделать прямой переход на облако клиента.
|
||||||
/clients/{id}/demo_enable - применение таблиц демо-данных
|
/clients/{id}/demo_enable - применение таблиц демо-данных
|
||||||
/clients/{id}/demo_disable - удаление демо-данных
|
/clients/{id}/demo_disable - удаление демо-данных
|
||||||
|
/clients/{id}/maintain_enable - включить страницу "Техническое обслуживание" у клиента
|
||||||
|
/clients/{id}/maintain_disable - отключить страницу "Техническое обслуживание"
|
||||||
/clients/{id}/send_success - отправить письмо клиенту с успешной регистрацией облака с логином и паролем
|
/clients/{id}/send_success - отправить письмо клиенту с успешной регистрацией облака с логином и паролем
|
||||||
/clients/{id}/send_expire - отправить письмо клиенту о скором истечении использования (можно/нужно автоматизировать)
|
/clients/{id}/send_expire - отправить письмо клиенту о скором истечении использования (можно/нужно автоматизировать)
|
||||||
/clients/{id}/expire_dates_history - история изменения продлений дат пользователя
|
/clients/{id}/expire_dates_history - история изменения продлений дат пользователя
|
||||||
/clients/{id}/reboot - попытка перезапуска контейнера пользователя
|
/clients/{id}/reboot - попытка перезапуска контейнера пользователя
|
||||||
/servers/{id}/reboot_server - перезапуск сервера
|
/servers/{id}/reboot_server - перезапуск сервера
|
||||||
|
/clients/{id}/create_log - Лог создания контейнера
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -31,7 +34,7 @@ POST:
|
|||||||
/servers/create — создать сервер в БД
|
/servers/create — создать сервер в БД
|
||||||
/clients/create — создать клиента - полный серверный цикл создания облака
|
/clients/create — создать клиента - полный серверный цикл создания облака
|
||||||
во время создания нужно таймером опрашивать
|
во время создания нужно таймером опрашивать
|
||||||
GET /clients/create_log и получать актуальный лог о создании контейнера. За окончание создания отвечает статус "completed" => "ok | error".
|
/clients/create_log и получать актуальный лог о создании контейнера. За окончание создания отвечает статус "completed" => "ok | error".
|
||||||
/clients/owner_password — задать новый пароль администратора лаборатории
|
/clients/owner_password — задать новый пароль администратора лаборатории
|
||||||
TODO: перенос данных клиента с одного сервера на другой
|
TODO: перенос данных клиента с одного сервера на другой
|
||||||
TODO: /cloud_admin_password - задать пароль для подключения к API
|
TODO: /cloud_admin_password - задать пароль для подключения к API
|
||||||
@@ -41,11 +44,15 @@ PUT | PATCH:
|
|||||||
```
|
```
|
||||||
/servers/{id} — изменить информацию о сервере
|
/servers/{id} — изменить информацию о сервере
|
||||||
/clients/{id} — редактировать данные клиента (кроме пароля администратора лабы)
|
/clients/{id} — редактировать данные клиента (кроме пароля администратора лабы)
|
||||||
/clients/{id}/expire_date - обновление крайней даты использования
|
/clients/{id}/expire_date - обновление крайней даты использования системы
|
||||||
```
|
```
|
||||||
|
|
||||||
DELETE
|
DELETE
|
||||||
```
|
```
|
||||||
/clients/{id}/delete — редкая функция — запуск очистки пользовательских конфигов с серверов
|
/clients/{id}/delete — редкая функция — запуск очистки пользовательских конфигов с серверов
|
||||||
/servers/{id}/delete – не реализовано, да и пока что не надо. Тут нужно просто удаление информации о сервере из БД.
|
/servers/{id}/delete – не реализовано, да и пока что не надо. Тут нужно просто удаление информации о сервере из БД.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### TODO: Добавить таблицу с настройками облака
|
||||||
|
- Проверка на настройку "Техническое обслуживание"
|
||||||
Reference in New Issue
Block a user