Обновление группы GROK паттернов
Запрос
Тип | Метод |
---|---|
PUT |
/grok_groups/update |
Описание: при выполнении запроса будет обновлена информация о группе GROK паттернов в соответствии с заданными параметрами.
Пример запроса
PUT
http://127.0.0.1/cluster-manager/v2/grok_groups/update
Тело запроса:
Параметр | Тип данных | Обязательность | Описание |
---|---|---|---|
id | string |
Required | Идентификатор группы GROK паттерна |
name | string |
Required | Название группы GROK паттерна |
patterns | Array <Grok> |
Required | Массив GROK паттернов, добавленных в группу |
trace_id | string |
Optional | Идентификатор трассировки действия пользователя для аудита |
Модель данных GROK
Параметр | Тип данных | Обязательность | Описание |
---|---|---|---|
id | string |
Required | Идентификатор GROK паттерна |
name | string |
Required | Название GROK паттерна |
group_id | string |
Required | Идентификатор группы GROK паттерна |
pattern | string |
Required | Правило паттерна |
is_client | boolean |
Required | Создан ли GROK паттерн пользователем |
is_debug | boolean |
Required | Флаг “Черновик” |
is_system | boolean |
Required | Является ли GROK паттерн системным |
created_at | string |
Required | Дата создания в формате date-time |
updated_at | string |
Required | Дата изменения в формате date-time |
trace_id | string |
Optional | Идентификатор трассировки действия пользователя для аудита |
Пример тела запроса
{
"id": "uuid",
"name": "string",
"patterns": [
{
"id": "uuid",
"name": "string",
"group_id": "uuid",
"pattern": "%{EMAILLOCALPART}@%{HOSTNAME}\n",
"is_client": false,
"is_debug": false,
"is_system": true,
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"trace_id": "uuid"
}
],
"trace_id": "uuid"
}
Успешный ответ
Статус код: 200
– успешное обновление информации о группе GROK паттернов.
Формат: JSON
.
Тело ответа: модель обновленной группы GROK паттернов.
Пример ответа
{
"id": "uuid",
"name": "string",
"patterns": [
{
"id": "uuid",
"name": "string",
"group_id": "uuid",
"pattern": "%{EMAILLOCALPART}@%{HOSTNAME}\n",
"is_client": false,
"is_debug": false,
"is_system": true,
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"trace_id": "uuid"
}
],
"created_at": "2023-12-20T00:00:01.652259Z",
"updated_at": "2023-12-20T00:00:01.652259Z",
"trace_id": "uuid"
}
Другие возможные ответы
Код | Ответ | Описание |
---|---|---|
400 |
Bad Request |
Неверный тип параметра запроса, либо отсутствует обязательный параметр |
404 |
not found |
Объект не найден |
500 |
Internal Server Error |
Другие ошибки при создании объекта |
Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.
Пример ответа
Код 400
{
"error": "Bad Request",
"error_code": 400
}
Код 404
{
"error": "Not Found",
"error_code": 404
}
Код 500
{
"error": "Internal Server Error",
"error_code": 500
}