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

Имя

Тип данных

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

Описание

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

page

number

Нет

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

1

id

string

Нет

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

00000000-0000-0000-0000-000000000000

tenantID

string

Нет

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

00000000-0000-0000-0000-000000000000

name

string

Нет

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

service
^My service$

kind

string

Нет

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

collector, correlator, storage, agent

fqdn

string

Нет

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

hostname

^hostname.example.com$

paired

bool

Нет

Выводить только те сервисы, которые выполнили первый запуск. Если параметр присутствует в URL query, его значение принимается за true. Указанные пользователем значения игнорируются. Пример: /api/v1/services?paired

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

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

вариативное

вариативное