Поиск ресурсов

15 мая 2024

ID 270065

GET /api/v1/kuma/resources

Доступ: Главный администратор, Администратор тенанта, Аналитик второго уровня, Аналитик первого уровня, Наблюдатель.

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

Имя

Тип данных

Обязательное ли поле

Описание

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

page

Числовое

Нет

Номер страницы. Начинается с 1. Размер страницы – 250 записей. Если параметр не указан, то используется значение по умолчанию – 1.

1

id

Строка

Нет

Идентификатор ресурса. Если параметр указан несколько раз, то формируется список и применяется логический оператор ИЛИ.

00000000-0000-0000-0000-000000000000

tenantID

Строка

Нет

Идентификатор тенанта ресурса. Если параметр указан несколько раз, то формируется список и применяется логический оператор ИЛИ. Если пользователь не имеет необходимой роли в указанном тенанте, то данный тенант игнорируется.

00000000-0000-0000-0000-000000000000

name

Строка

Нет

Имя ресурса. Регистронезависимое регулярное выражение (PCRE).

resource
^My resource$

kind

Строка

Нет

Тип ресурса. Если параметр указан несколько раз, то формируется список и применяется логический оператор ИЛИ.

collector, correlator, storage, activeList, aggregationRule, connector, correlationRule, dictionary, 

enrichmentRule, destination, filter, normalizer, responseRule, search, agent, proxy, secret

Действие по реагированию

HTTP-код: 200

Формат: JSON

type Response []Resource

 

type Resource struct {

ID string `json:"id"`

Kind string `json:"kind"`

Name string `json:"name"`

Description string `json:"description"`

TenantID string `json:"tenantID"`

TenantName string `json:"tenantName"`

UserID string `json:"userID"`

UserName string `json:"userName"`

Created string `json:"created"`

Updated string `json:"updated"`

}

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

HTTP-код

Описание

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

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

400

Неверное значение параметра page

invalid query parameter value

page

400

Неверное значение параметр kind

invalid kind

<kind>

500

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

Переменная.

Переменная.

Вам помогла эта статья?
Что нам нужно улучшить?
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!