RES. Руководство пользователя: различия между версиями
Материал из Флора AI
(Новая страница: «Report Engine Service») |
Нет описания правки |
||
| Строка 1: | Строка 1: | ||
Report | ===== '''Общее описание''' ===== | ||
Сервис предназначен для: | |||
- сбора статистических данных с сервисов ses и передачи их в elasticsearch | |||
- передачи отчетов, разработанных в kibana в интерфейс UPS | |||
====='''Термины и определения'''===== | |||
Report tngine service (RES) - сервис отчетов. | |||
Swagger UI – интерактивная веб-консоль с кратким описанием методов АPI и возможностью выполнять запросы к сервису RES в реальном времени | |||
===== '''Описание методов API''' ===== | |||
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом RES. По умолчанию используется порт 6189/tcp. | |||
Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок <code>"accept: application/json"</code> | |||
Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл. | |||
Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6189 будет отображен интерфейс swagger со всеми методами с возможностью их проверки. | |||
{| class="wikitable" style="width: 110%" | |||
|+''Описание методов API'' | |||
! style="color:blue;width: 15%" |'''GET/res/dashboards''' | |||
! colspan="3" style="width: 85%" |<small>Вывод списка отчетов.</small> | |||
|- | |||
| colspan="2" style="width: 50%" |<small>Входные параметры отсутствуют</small> | |||
| colspan="2" style="width: 50%" |<small><code>{ models: [model1,...,modelN] }</code></small> | |||
|} | |||
Версия от 17:16, 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 | Вывод списка отчетов. | ||
|---|---|---|---|
| Входные параметры отсутствуют | { models: [model1,...,modelN] }
| ||