Подсистема мониторинга

Подсистема мониторинга предоставляет API для интеграции со сторонними системами, извлекающими метрики.

API принимает запросы и отдаёт ответы в формате JSON.

Аутентификация

Для доступа к API требуется токен доступа. Передавайте его в заголовке запроса:

Authorization: Bearer <token>

Фильтрация по ролям

Эндпоинты POST /alerts и GET /object поддерживают фильтрацию данных по ролям пользователя.

Если при обращении к ним используется токен доступа, можно дополнительно передать заголовок X-Auth-UserRoles со списком ролей. Этот заголовок использует API Gateway Платформы.

X-Auth-UserRoles: <role1>,<role2>,...,<roleN>

Когда заголовок передан, данные в ответе фильтруются в соответствии с перечисленными ролями.

Если ни одна роль не даёт доступа к данным, в ответе возвращается пустой результат.

Структура ответа

Эндпоинты возвращают ответ в формате JSON. Список возможных полей:

data

Данные ответа. Их состав зависит от эндпоинта.

error

Информация об ошибке:

desc: Описание ошибки.
detail: Детали ошибки.
name: Название ошибки.

message

Информационное сообщение:

extra: Дополнительные данные сообщения.
text: Текст сообщения.
type: Тип сообщения.

next_offset

Сколько записей нужно пропустить, чтобы получить следующую страницу результатов.

status

Статус выполнения запроса.

total_count

Общее количество элементов.