Действия

BSS. Руководство пользователя: различия между версиями

Материал из Флора AI

Строка 7: Строка 7:
===== '''Термины и определения''' =====
===== '''Термины и определения''' =====
Сервис Backup Service System (BSS) – сервис резервного копирования.
Сервис Backup Service System (BSS) – сервис резервного копирования.
Swagger UI – интерактивная  веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису BSS.
Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису BSS.





Версия от 17:37, 18 февраля 2025

BSS. Руководство пользователя

Общее описание

Сервис Backup Service System (BSS) предназначен для резервного копирования данных сервисов Флора AI.


Термины и определения

Сервис Backup Service System (BSS) – сервис резервного копирования. Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису BSS.


Описание методов API BSS

Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом BSS. По умолчанию используется порт 6199/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок "accept: application/json"


Описание методов API
POST/bss/backup/{ip} Принудительный бэкап сервера. На выходе id задания или сообщение об ошибке
  • ip - ip адрес сервера данные с которого будут сохранены. IP адрес и каталоги с данными должны быть в конфиге
{  "task_id": "73c8b134-4883-445c-ba9d-3058962bda43" }
POST/bss/config Обновить конфигурацию. Установит новый конфиг и заставит сервис его перечитать.
config - json новой конфигурации, структура как у config.json {  "message": "Configuration updated and reload requested" }
GET/bss/config Получить текущую конфигурацию
Нет параметров Содержимое файла cjnfig.json
GET/bss/tasks Получить список всех заданий и их результатов за последние два дня
Нет параметров Список словарей заданий. в каждом элементы:

task_id, ip_address, status, result, timestamp