Добавление активного действия к правилу корреляции
Запрос
| Тип | Метод |
|---|---|
POST |
/logmule_go_rules_integration_actions/create |
Описание: При выполнении запроса в правило корреляции будет добавлено активное действие.
Пример запроса
POST
http://127.0.0.1/cruddy/v2/logmule_go_rules_integration_actions/create
Тело запроса:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| rule_id | string |
Required | Идентификатор правила корреляции в формате uuid |
| integration_script_id | string |
Required | Идентификатор команды (скрипта) интеграции в формате uuid |
| params | Array<object> |
Required | Список параметров для запуска команды (скрипта) интеграции |
| params{parameter_name} | string |
Required | Имя передаваемого параметра |
| params{parameter_value} | string |
Required | Значение параметра |
| params{from_logline} | boolean |
Required | Флаг для получения значения параметра из логлайна (события). Если true, поле parameter_value должно содержать название поля логлайна (может содержать . для полей вложенных объектов) |
| params{strategy} | string |
Required | Стратегия выбора логлайна из массива. Поддерживаемые значения: - first — выбора первого логлайна,- last — выбора последнего логлайна. |
| state | boolean |
Required | Состояние активного действия в интеграции: вкл/выкл |
Пример тела запроса
{
"rule_id": "728c1541-d6d1-4290-9a53-cdf01dd32d60",
"integration_script_id": "45690f50-c449-45c5-9c71-4e6d0b54c790",
"params": [
{
"parameter_name": "string",
"parameter_value": "string",
"from_logline": true,
"strategy": "first"
}
],
"state": true
}
Успешный ответ
Статус код: 201 – успешное добавление.
Формат: JSON
Тело ответа: модель активного действия в правиле корреляции.
Пример ответа
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"rule_id": "728c1541-d6d1-4290-9a53-cdf01dd32d60",
"integration_script_id": "45690f50-c449-45c5-9c71-4e6d0b54c790",
"params": [
{
"parameter_name": "string",
"parameter_value": "string",
"from_logline": true,
"strategy": "first"
}
],
"state": true
}
Другие возможные ответы
| Код | Ответ | Описание |
|---|---|---|
400 |
1. Bad Request2. missing uid header3. Pgr-User-Id should be uuid format4. empty rule_id5. rule_id should be uuid format6. empty integration_script_id7. integration_script_id should be uuid format8. rule not found9. integration script not found |
1. Неверный тип параметра запроса, либо отсутствует обязательный параметр 2. Не передан заголовок Pgr-User-ID 3. Недопустимый формат Pgr-User-ID 4. ID правила корреляции не может быть пустым 5. Недопустимый формат ID правила 6. ID скрипта (команды) интеграции не может быть пустым 7. Недопустимый формат ID скрипта (команды) интеграции 8. Правило с переданным ID не найдено 9. Скрипт с переданным ID не найден |
500 |
Internal Server Error |
Другие ошибки при удалении объектов |
Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.
Пример ответа
Код 400
{ "error": "Bad Request", "error_code": 400 }Код 500
{ "error": "Internal Server Error", "error_code": 500 }