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

Создание фильтра потока событий

Запрос

Тип Метод
POST /logmule_go_filters/create

Описание: При выполнении запроса будет создан фильтр потока событий с заданными параметрами.

Пример запроса

POST
http://127.0.0.1/cruddy/v2/logmule_go_filters/create

Тело запроса:

Параметр Тип Обязательность Описание
name string Required Название фильтра
config Array<Config> Required Список фильтров по полям
LogmuleGoFiltersConfig
Параметр Тип Обязательность Описание
compareFn string Required Функция сравнения. Допустимые значения:equal, substr, exist, intersection
expressions object Required Выражения использующиеся в функции сравнения. >= 1 знаков
expressions{type} string Required Тип выражения. Допустимые значения: logline-get, const-string, const-null, const-string-array
expressions{value} object Required Значение
type string Required Тип условия. Допустимые значения: compare-condition
parentId string Optional Идентификатор родительского элемента
ignore_case boolean Optional Флаг: игнорировать ли регистр при сравнении строковых данных
negation boolean Optional Флаг: выполнять ли инверсию по результатам сравнения
Пример тела запроса

{
  "name": "string",
  "config": [
    {
      "compareFn": "equal",
      "expressions": [
        {
          "type": "logline-get",
          "value": {}
        }
      ],
      "type": "compare-condition",
      "parentId": "string",
      "ignore_case": true,
      "negation": true
    }
  ]
}

Успешный ответ

Статус код: 201 - успешное создание фильтра потока событий.

Формат: JSON.

Тело ответа: модель созданного фильтра потока событий.

Пример ответа

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "config": [
    {
      "compareFn": "equal",
      "expressions": [
        {
          "type": "logline-get",
          "value": {}
        }
      ],
      "type": "compare-condition",
      "parentId": "string",
      "ignore_case": true,
      "negation": true
    }
  ],
  "logmule_go_rules": null,
  "stats": {
    "hit_count": 0,
    "hit_eps": 0,
    "check_count": 0,
    "check_eps": 0,
    "check_time": 0
  },
  "_relations": {
    "logmule_go_rules": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }
}

Другие возможные ответы

Код Ответ Описание
400 Bad Request Неверный тип параметра запроса, либо отсутствует обязательный параметр
409 name_already_used Попытка создать объект с существующим уникальным атрибутом
500 Internal Server Error Другие ошибки при создании объекта

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа
Код 400

{
  "error": "Bad Request",
  "error_code": 400
}

Код 409

{
  "error": "name_already_used",
  "error_code": 409,
  "extra": {
    "fields": [
      "name"
    ]
  }
}

Код 500

{
  "error": "Internal Server Error",
  "error_code": 500
}