Импорт записей в контекстную таблицу

POST /api/v1/contextTables/import

Целевой коррелятор должен быть запущен.

Доступ: Главный администратор, Администратор тенанта, Аналитик второго уровня, Аналитик первого уровня (может импортировать данные в любую таблицу коррелятора доступного тенанта, даже если контекстная таблица, создана в Общем тенанте).

Параметры запроса (URL Query)

Имя

Тип данных

Обязательный

Описание

Пример значения

correlatorID

string

Да

Идентификатор сервиса коррелятора

00000000-0000-0000-0000-000000000000

contextTableID

string

Если не указан contextTableName

Идентификатор контекстной таблицы

00000000-0000-0000-0000-000000000000

contextTableName

string

Если не указан contextTableID

Имя контекстной таблицы

Attackers

format

string

Да

Формат импортируемых записей

CSV, TSV, internal

clear

bool

Нет

Очистить контекстную таблицу перед выполнением импорта. Если параметр присутствует в URL query, его значение принимается как true. Указанные пользователем значения игнорируются.

/api/v1/contextTables/import?clear

Тело запроса

Формат

Содержимое

CSV

Первая строка - заголовок, где перечислены поля, разделенные запятой. Остальные строки - значения, соответствующие полям в заголовке, разделенные запятой. Количество полей на каждой строке должно быть одинаковым и должно соответствовать количеству полей в схеме контекстной таблицы. Значения списочных полей разделяются символом "|". Например, значение списочного поля целочисленного типа - 1|2|3.

TSV

Первая строка - заголовок, где перечислены поля, разделенные TAB. Остальные строки - значения, соответствующие полям в заголовке, разделенные TAB. Количество полей на каждой строке должно быть одинаковым и должно соответствовать количеству полей в схеме контекстной таблицы. Значения списочных полей разделяются символом "|".

internal

Каждая строка содержит один индивидуальный объект JSON. Данные в internal формате можно получить путем экспорта содержимого контекстной таблицы из коррелятора в веб-консоли KUMA.

Ответ

HTTP-код: 204

Возможные ошибки

HTTP-код

Описание

Значение поля message

Значение поля details

400

Не указан идентификатор сервиса коррелятора.

query parameter required

correlatorID

400

Не указан ни параметр contextTableID, ни параметр contextTableName.

one of query parameters required

contextTableID, contextTableName

400

Не указан параметр format.

query parameter required

format

400

Параметр format имеет неверное значение.

invalid query parameter value

format

400

Тело запроса имеет нулевую длину.

request body required

-

400

Ошибка парсинга тела запроса, а том числе соответствие схеме контекстной таблицы наименования полей и типов импортируемой записи.

correlator API request failed

вариативное

403

Пользователь не имеет необходимой роли в тенанте коррелятора.

access denied

-

404

Сервис с указанным идентификатором correlatorID не найден.

service not found

-

404

Контекстная таблица не найдена.

context table not found

-

406

Сервис с указанным идентификатором correlatorID не является коррелятором.

service is not correlator

-

406

Коррелятор не выполнил первый запуск.

service not paired

-

406

Тенант коррелятора отключен.

tenant disabled

-

406

Поиск контекстной таблицы выполнялся по имени contextTableName и было найдено более одной контекстной таблицы.

more than one matching context tables found

-

50x

Не удалось обратиться к API коррелятора.

correlator API request failed

вариативное

500

Ошибка подготовки данных для импорта в сервис коррелятора.

context table process import request failed

вариативное

500

Любые другие внутренние ошибки.

вариативное

вариативное

В начало