Swagger UI

В этом разделе описано, как пользоваться доступными API-методами Платформы с помощью Swagger UI:

Подготовка - инструкция авторизации в Swagger UI.
Использование - алгоритм использования API-методов.
Основные параметры - инструкция получения параметров для использования API-методов.

Попасть на страницу документации в Swagger можно, нажав на значок пользователя → «Swagger API».

Подготовка

Чтобы воспользоваться API-методами, необходимо авторизоваться через Swagger UI:

Создайте токен нужного вам типа в зависимости от API-методов, которые будете использовать (или воспользуйтесь таким токеном, если он у вас уже существует):

Для использования метода, связанного с Агентом, расположенного в самом верху, необходим токен типа установка.
Чтобы воспользоваться методами, связанными с метриками, необходим токен типа метрики.
Для использования метода, связанного с датасетами, необходим токен типа датасеты.
Чтобы воспользоваться всеми остальными API-методами, необходим токен типа публичное API.

Нажмите на кнопку «Authorize» («Авторизоваться»).

В текстовое поле появившегося модального окна вставьте соответствующий ключ (цифра 1 на рисунке ниже) и нажмите на кнопку «Authorize» (цифра 2 на рисунке ниже).

Использование

В общем виде алгоритм использования API-методов через Swagger UI представляет следующий алгоритм:

Кликните на стрелочку или любой другой элемент строки конкретного API-метода, чтобы его развернуть.

Нажмите на кнопку «Try it out» (цифра 1 на рисунке ниже).

Введите необходимые параметры (цифра 2 на рисунке выше), если они требуются. Для того, чтобы воспользоваться конкретным API-методом, требующим ввода параметров, достаточно заполнить обязательные поля, помеченные красным словом «required».
Кликните на кнопку «Execute».

Если полученный вами код ответа соответствует тому, который был в примере до нажатия этой кнопки, запрос выполнился успешно.

Основные параметры

workspaceCode

Подробнее

Код рабочего пространства можно получить, воспользовавшись API-методом получения всех рабочих пространств данного тенанта.

В ответе запроса придёт вся информация о рабочих пространствах данного тенанта, в том числе их код.

instanceKey

Подробнее

Ключ экземпляра БД можно получить, воспользовавшись API-методом получения всех экземпляров данного рабочего пространства.

В ответе запроса придёт вся информация об экземплярах данного рабочего пространства, в том числе их ключ.

clusterKey

Подробнее

Ключ кластера можно получить, воспользовавшись API-методом получения всех кластеров данного рабочего пространства.

В ответе запроса придёт вся информация о кластерах данного рабочего пространства, в том числе их ключ.

integrationMetricType

Подробнее

integrationMetricType - это название системы мониторинга, с помощью которой вам нужно вывести метрики. На данный момент у Платформы две таких интеграции:

prometheus
zabbix

dbName

Подробнее

Имя базы данных можно получить, воспользовавшись API-методом получения всех БД данного экземпляра.

В ответе запроса придёт вся информация о БД данного экземпляра, в том числе их названия.

groupId

Подробнее

ID группы находится на странице всех групп данного тенанта в столбце «ИД группы».

userId

Подробнее

ID пользователя можно получить двумя способами:

Зайдя на страницу пользователей данного тенанта. Данный параметр находится в столбце «ИД пользователя».

Воспользовавшись API-методом получения всех пользователей данной группы по её ID.

В ответе запроса придёт вся информация о пользователях данной группы, в том числе их ID.

userProps

Подробнее

Этот параметр включает в себя два поля:

languageCode - локаль пользователя («ru» или «en»).

timeZone - часовой пояс пользователя в формате «Континент/регион» (например, «Europe/Moscow»).

ownerID

Подробнее

ID Владельца тенанта это ID пользователя, которому даны права Владельца тенанта. Его можно получить, воспользовавшись API-методом получения всех Владельцев данного тенанта.

В ответе запроса придёт вся информация о Владельцах данного тенанта, в том числе их ID.