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

Версия от 13:07, 20 февраля 2025

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

Данный сервис предназначен для сбора статистических данных с сервисов SES, их передачи в Elasticsearch для последующей обработки и последующего перенаправления разработанных в Kibana отчетов в интерфейс UPS.

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

Report engine service (RES) — сервис отчетов.

Swagger UI — интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису RES в реальном времени.

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

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

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

Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл.

Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6189 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

*Описание методов API*
GET/res/dashboards	Вывод списка отчетов. Метод для использования в UPS
Входные параметры отсутствуют		{ "error": 0, "message": "success", "dashboards": { "Названиа отчета1": "ссылка на отчет1", ........... "Названиа отчетаN": "ссылка на отчетN", } }
POST/res/log/upload	Загрузка статистики с сервисов SES. Метод для использования в UPS
date — день, за который требуется загрузить статистику, в формате %Y-%m-%d (например, 2024-11-01).rewrite — перезаписывать индексы (yes/no).		{ "error": 0, "message": "success"}

Создание отчетов

Раздел в разработке

@@ Строка 1: / Строка 1: @@
 ====== '''Общее описание''' ======
-Сервис предназначен для сбора статистических данных с сервисов SES и передачи их в elasticsearch - передачи отчетов, разработанных в kibana в интерфейс UPS.
+Данный сервис предназначен для сбора статистических данных с сервисов SES, их передачи в Elasticsearch для последующей обработки и последующего перенаправления разработанных в Kibana отчетов в интерфейс UPS.
 ====== '''Термины и определения''' ======
@@ Строка 37: / Строка 37: @@
 |-
 | colspan="2" style="width: 50%" |
-* <small>'''date''' - день, за который требуется загрузить статистику в формате %Y-%m-%d (например 2024-11-01)</small>
+* <small>date — день, за который требуется загрузить статистику, в формате %Y-%m-%d (например, 2024-11-01).</small><small>rewrite — перезаписывать индексы (yes/no).</small>
-* <small>'''rewrite''' - перезаписывать индексы (yes/no)</small>
 | colspan="2" style="width: 50%" |<small>{  "error": 0,</small>