Создание шаблона группировки
Запрос
Тип | Метод |
---|---|
POST |
/logmule_go_templates_grouper/create |
Описание: При выполнении запроса будет создан шаблон с заданными параметрами.
Пример запроса
POST
http://127.0.0.1/cruddy/v2/logmule_go_templates_grouper/create
Тело запроса:
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
trace_id | string |
Optional | Идентификатор трассировки действия пользователя для аудита |
name | string |
Required | Название шаблона группера |
grouped_by | Array<string> |
Required | Поля для группировки |
aggregated_by | Array<string> |
Required | Поля для агрегации |
grouped_time_field | string |
Required | Время события (название поля) |
grouped_time_type | string |
Required | Формат времени, одно из: “RFC3339Nano”, “RFC3339”, “ANSIC”, “UnixDate”, “RubyDate”, “RFC822”, “RFC822Z”, “RFC850”, “RFC850”, “RFC1123”, “RFC1123Z”, “Stamp”, “StampMilli”, “StampMicro”, “StampNano”, “UnixMilli”, “UnixMicro” |
detection_windows | integer |
Required | Период группировки |
detection_windows_unit | string |
Required | Единица измерения периода группировки. Допустимые значения: - ms - s - m - h |
aggregate_count | integer |
Required | Порог количества событий для срабатывания |
aggregate_unique | boolean |
Required | Флаг: активировать ли только уникальные события. |
Пример тела запроса
{
"trace_id": "uuid",
"name": "string",
"grouped_by": [
"string"
],
"aggregated_by": [
"string"
],
"grouped_time_field": "string",
"grouped_time_type": "2023-12-20T00:00:01.652259Z",
"detection_windows": 5,
"detection_windows_unit": "ms",
"aggregate_count": 1,
"aggregate_unique": true
}
Успешный ответ
Статус код: 201
- успешное создание шаблона.
Формат: JSON
.
Тело ответа: модель созданного шаблона.
Пример ответа
{
"id": "uuid",
"trace_id": "uuid",
"name": "string",
"grouped_by": [
"string"
],
"aggregated_by": [
"string"
],
"grouped_time_field": "string",
"grouped_time_type": "2023-12-20T00:00:01.652259Z",
"detection_windows": 5,
"detection_windows_unit": "ms",
"aggregate_count": 1,
"aggregate_unique": true
}
Другие возможные ответы
Код | Ответ | Описание |
---|---|---|
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
}