Перейти к содержанию

Обзор

Основные характеристики

Характеристика Значение
Наименование logmule_go_results
Компоненты Cruddy
Появился в версии 3.7.0
Доступен в версиях 3.7.0 и выше
Авторизация по токену Security scheme type: http
Bearer format: JWT
Авторизация по APIkey Security scheme type: apiKey
Header parameter name: PgrApiKey
Версия API v2

Описание: Ресурс logmule_go_results отвечает за управление результатами "сработок" правил корреляции. Результатом работы коррелятора является  так называемая "сработка" правила корреляции, на основании которой может быть создан инцидент и проведен анализ.

Список методов для работы с ресурсом

Тип Метод Описание
POST /logmule_go_results/create Создание результата "сработки" правила
PUT /logmule_go_results/update Обновление информации о результате "сработки" правила
POST /logmule_go_results/search Поиск результатов "сработок" правил
GET /logmule_go_results/{id} Получение результата "сработки" правила по ID
DELETE /logmule_go_results/{id} Удаление результата "сработки" правила
POST /logmule_go_results/group Группировка результатов "сработок" правил
POST /logmule_go_results/mass_delete Массовое удаление результатов "сработок" правил
DELETE /logmule_go_results/all Удаление всех результатов "сработок" правил
GET /logmule_go_results/_meta Получение свойств полей результатов "сработок" правил и действий пользователей
POST /logmule_go_results/create_from_event_manual Создание результата "сработки" правила в созданном происшествии
POST /logmule_go_results/add_to_incident Добавление результата к инциденту
POST /logmule_go_results/{id}/create_incident Создание инцидента на основе результата "сработки" правила
GET /logmule_go_results/event_by_occ_id/{occurrence_id} Поиск событий по ID происшествия
GET /logmule_go_results/event_by_result_id/{id} Поиск событий по ID результата

Ответы методов

Статус код Описание
200 Успех
201 Успешное создание объекта
204 Успешный ответ. Пустое тело ответа
400 Неверный тип параметра запроса, либо отсутствует обязательный параметр
404 Ресурс не найден
409 Попытка присвоить объекту существующее уникальное значение атрибута
422 Внутрення ошибка удаления
500 Ошибка сервера

Модели объектов

Название Описание
LogmuleGoResult Модель данных ресурса logmule_go_results