Поиск служб

GET /xdr/api/v2.1/kuma/services/

Доступ: Главный администратор, Администратор тенанта, Аналитик 2-го уровня, Аналитик 1-го уровня.

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

Имя	Тип данных	Обязательное ли поле	Описание	Пример значения
page	Числовое	Нет	Номер страницы. Начинается с 1. Размер страницы – 250 записей. Если параметр не указан, то используется значение по умолчанию – 1.	1
id	Строка	Нет	Идентификатор сервиса. Если параметр указан несколько раз, то формируется список и применяется логический оператор ИЛИ.	00000000-0000-0000-0000-000000000000
tenantID	Строка	Нет	Идентификатор тенанта сервиса. Если параметр указан несколько раз, то формируется список и применяется логический оператор ИЛИ. Если пользователь не имеет необходимой роли в указанном тенанте, то данный тенант игнорируется.	00000000-0000-0000-0000-000000000000
name	Строка	Нет	Имя службы. Регистронезависимое регулярное выражение (PCRE).	service ^My service$
kind	Строка	Нет	Тип сервиса. Если параметр указан несколько раз, то формируется список и применяется логический оператор ИЛИ.	collector, correlator, storage, agent
fqdn	Строка	Нет	FQDN сервиса. Регистронезависимое регулярное выражение (PCRE).	hostname ^hostname.example.com$
paired	bool	Нет	Выводить только те сервисы, которые выполнили первый запуск. Если параметр присутствует в URL query, его значение принимается за true. Указанные пользователем значения игнорируются.	/xdr/api/v2.1/kuma/services?paired

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

HTTP-код: 200

Формат: JSON

type Response []Service

type Service struct {

ID string `json:"id"`

TenantID string `json:"tenantID"`

TenantName string `json:"tenantName"`

ResourceID string `json:"resourceID"`

Kind string `json:"kind"`

Name string `json:"name"`

Address string `json:"address"`

FQDN string `json:"fqdn"`

Status string `json:"status"`

Warning string `json:"warning"`

APIPort string `json:"apiPort"`

Uptime string `json:"uptime"`

Version string `json:"version"`

Created string `json:"created"`

Updated string `json:"updated"`

}

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

HTTP-код	Описание	Значение поля `message`	Значение поля `details`
400	Неверное значение параметра page	invalid query parameter value	page
400	Неверное значение параметр kind	invalid kind	<kind>
500	Любая другая внутренняя ошибка.	Переменная.	Переменная.

В начало