RES. Руководство пользователя: различия между версиями
Материал из Флора AI
| Строка 23: | Строка 23: | ||
|- | |- | ||
| colspan="2" style="width: 50%" |<small>Входные параметры отсутствуют</small> | | colspan="2" style="width: 50%" |<small>Входные параметры отсутствуют</small> | ||
| colspan="2" style="width: 50%" |<small>{ "error": 0,</small> | |||
<small> "message": "success",</small> | |||
<small> "dashboards": {</small> | |||
<small> "Названиа отчета1": "ссылка на отчет1",</small> | |||
........... | |||
<small> "Названиа отчетаN": "ссылка на отчетN", } }</small> | |||
|- | |||
! style="color:green;width: 15%" |'''POST/res/log/upload''' | |||
! colspan="3" style="width: 85%" |Загрузка статистики с сервисов SES. <small>Метод для использования в UPS</small> | |||
|- | |||
| colspan="2" style="width: 50%" |<small>date</small> | |||
| colspan="2" style="width: 50%" |<small>{ "error": 0,</small> | | colspan="2" style="width: 50%" |<small>{ "error": 0,</small> | ||
Версия от 17:23, 1 ноября 2024
Общее описание
Сервис предназначен для: - сбора статистических данных с сервисов ses и передачи их в elasticsearch - передачи отчетов, разработанных в kibana в интерфейс UPS
Термины и определения
Report tngine service (RES) - сервис отчетов. Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису RES в реальном времени
Описание методов API
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом RES. По умолчанию используется порт 6189/tcp.
Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок "accept: application/json"
Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл.
Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6189 будет отображен интерфейс swagger со всеми методами с возможностью их проверки.
| GET/res/dashboards | Вывод списка отчетов. Метод для использования в UPS | ||
|---|---|---|---|
| Входные параметры отсутствуют | { "error": 0,
"message": "success", "dashboards": { "Названиа отчета1": "ссылка на отчет1", ........... "Названиа отчетаN": "ссылка на отчетN", } } | ||
| POST/res/log/upload | Загрузка статистики с сервисов SES. Метод для использования в UPS | ||
| date | { "error": 0,
"message": "success", "dashboards": { "Названиа отчета1": "ссылка на отчет1", ........... "Названиа отчетаN": "ссылка на отчетN", } } | ||