Плагины

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

GET /v2/addons/{addonName}

Получение списка версий плагина.

Parameters

  • addonName (string) – Название плагина.

Status Codes

  • 200 OK – A successful response.

Response JSON Object

  • releases (array) – Список доступных версий плагина.

  • releases[].addonNamespace (string) – Пространство имен, в которое должен устанавливаться плагин.

  • releases[].addonVersion (string) – Версия плагина в формате SemVer.

  • releases[].configurationSchema (string) – JSON схема, относительно которой валидируется конфигурация плагина.

  • releases[].createdAt (string) – Дата и время создания версии плагина.

  • releases[].kubeVersions (string) – Диапазон поддерживаемых версий Kubernetes в формате SemVer.

  • releases[].mode (string) – Режим поддержки версии.

  • releases[].updatedAt (string) – Дата и время обновления версии плагина.

GET /v2/addons

Получение списка доступных плагинов.

Status Codes

  • 200 OK – A successful response.

Response JSON Object

  • addons (array) – Список доступных плагинов.

  • addons[].categories (array) – Категории плагина.

  • addons[].categories[] (string) – Категория плагина.

  • addons[].createdAt (string) – Дата и время создания плагина.

  • addons[].description (string) – Описание плагина для пользователя.

  • addons[].displayName (string) – Название плагина в удобочитаемом виде.

  • addons[].name (string) – Название плагина.

  • addons[].updatedAt (string) – Дата и время последнего обновления плагина.

GET /v2/clusters/{clusterId}/addons

Получение списка плагинов кластера.

Parameters

  • clusterId (string) – Идентификатор кластера.

Query Parameters

  • all (boolean) – Получить все активные и ранее удаленные плагинов кластера.

Status Codes

  • 200 OK – A successful response.

Response JSON Object

  • addons (array) – Информация о плагинах.

  • addons[].addedAt (string) – Дата и время добавления плагина в кластер.

  • addons[].addedBy (string) – Идентификатор пользователя, который добавил плагин в кластер.

  • addons[].addonId (string) – Идентификатор плагина.

  • addons[].addonName (string) – Название плагина, например cilium.

  • addons[].addonVersion (string) – Версия плагина в формате SemVer.

  • addons[].clusterId (string) – Идентификатор кластера.

  • addons[].history (array) – История изменений плагина.

  • addons[].history[].addonConfiguration (string) – Пользовательская конфигурация плагина.

  • addons[].history[].addonNamespace (string) – Пространство имен, в пределах которого выполняется действие над плагином.

  • addons[].history[].createdAt (string) – Дата и время действия.

  • addons[].history[].createdBy (string) – Идентификатор пользователя, который инициировал действие над плагином.

  • addons[].history[].issues (array) – Список проблем, возникших при выполнении действия.

  • addons[].history[].issues[].code (string) – Код возможных проблем.

  • addons[].history[].issues[].message (string) – Содержание проблемы.

  • addons[].history[].params (array) – Список параметров, используемых при выполнении действия над плагином.

  • addons[].history[].params[].name (string) – Имя параметра.

  • addons[].history[].params[].value (string) – Значение параметра.

  • addons[].history[].status (string) – Статус действия.

  • addons[].history[].type (string) – Тип действия над плагином.

  • addons[].status (string) – Статус плагина в кластере.

  • addons[].updatedAt (string) – Дата и время последнего изменения плагина.

POST /v2/clusters/{clusterId}/addons

Добавление нового плагина в кластер.

Parameters

  • clusterId (string) – Идентификатор кластера.

Request JSON Object

  • addonConfiguration (string) – Пользовательская конфигурация плагина в JSON формате согласно схеме. Поддерживает переменные автоподстановки, заключенные в символы {{ и }}: - {{clusterID}} — уникальный идентификатор кластера; - {{clusterName}} — программное имя кластера; - {{productInstanceID}} — идентификатор экземпляра продукта; - {{nodeCIDR}} — CIDR сети узлов; - {{serviceCIDR}} — CIDR сервисной сети.

  • addonName (string) – Название плагина, например cilium.

  • addonVersion (string) – Версия плагина в формате SemVer.

  • resolveMode (string) – Режим разрешения конфликтов.

Status Codes

  • 200 OK – A successful response.

Response JSON Object

  • addon (object) – Информация о плагине.

  • addon.addedAt (string) – Дата и время добавления плагина в кластер.

  • addon.addedBy (string) – Идентификатор пользователя, который добавил плагин в кластер.

  • addon.addonId (string) – Идентификатор плагина.

  • addon.addonName (string) – Название плагина, например cilium.

  • addon.addonVersion (string) – Версия плагина в формате SemVer.

  • addon.clusterId (string) – Идентификатор кластера.

  • addon.history (array) – История изменений плагина.

  • addon.history[].addonConfiguration (string) – Пользовательская конфигурация плагина.

  • addon.history[].addonNamespace (string) – Пространство имен, в пределах которого выполняется действие над плагином.

  • addon.history[].createdAt (string) – Дата и время действия.

  • addon.history[].createdBy (string) – Идентификатор пользователя, который инициировал действие над плагином.

  • addon.history[].issues (array) – Список проблем, возникших при выполнении действия.

  • addon.history[].issues[].code (string) – Код возможных проблем.

  • addon.history[].issues[].message (string) – Содержание проблемы.

  • addon.history[].params (array) – Список параметров, используемых при выполнении действия над плагином.

  • addon.history[].params[].name (string) – Имя параметра.

  • addon.history[].params[].value (string) – Значение параметра.

  • addon.history[].status (string) – Статус действия.

  • addon.history[].type (string) – Тип действия над плагином.

  • addon.status (string) – Статус плагина в кластере.

  • addon.updatedAt (string) – Дата и время последнего изменения плагина.

GET /v2/clusters/{clusterId}/addons/get

Получение информации по плагинам кластера.

Parameters

  • clusterId (string) – Идентификатор кластера.

Query Parameters

  • addonId (string) – Идентификатор плагина.

  • addonName (string) – Название плагина, например cilium. Поиск по названию выполняется только среди активных плагинов. Для получения информации по удаленному плагину указывайте идентификатор плагина.

Status Codes

  • 200 OK – A successful response.

Response JSON Object

  • addon (object) – Информация о плагине.

  • addon.addedAt (string) – Дата и время добавления плагина в кластер.

  • addon.addedBy (string) – Идентификатор пользователя, который добавил плагин в кластер.

  • addon.addonId (string) – Идентификатор плагина.

  • addon.addonName (string) – Название плагина, например cilium.

  • addon.addonVersion (string) – Версия плагина в формате SemVer.

  • addon.clusterId (string) – Идентификатор кластера.

  • addon.history (array) – История изменений плагина.

  • addon.history[].addonConfiguration (string) – Пользовательская конфигурация плагина.

  • addon.history[].addonNamespace (string) – Пространство имен, в пределах которого выполняется действие над плагином.

  • addon.history[].createdAt (string) – Дата и время действия.

  • addon.history[].createdBy (string) – Идентификатор пользователя, который инициировал действие над плагином.

  • addon.history[].issues (array) – Список проблем, возникших при выполнении действия.

  • addon.history[].issues[].code (string) – Код возможных проблем.

  • addon.history[].issues[].message (string) – Содержание проблемы.

  • addon.history[].params (array) – Список параметров, используемых при выполнении действия над плагином.

  • addon.history[].params[].name (string) – Имя параметра.

  • addon.history[].params[].value (string) – Значение параметра.

  • addon.history[].status (string) – Статус действия.

  • addon.history[].type (string) – Тип действия над плагином.

  • addon.status (string) – Статус плагина в кластере.

  • addon.updatedAt (string) – Дата и время последнего изменения плагина.

DELETE /v2/clusters/{clusterId}/addons/{addonName}

Удаление плагина из кластера.

Parameters

  • clusterId (string) – Идентификатор кластера.

  • addonName (string) – Название плагина, например cilium.

Query Parameters

  • preserve (boolean) – Если флаг установлен, то сервис не будет управлять плагином, но плагин не будет удален из кластера.

Status Codes

  • 200 OK – A successful response.

Response JSON Object

  • action (object) – Информация об обновлении плагина.

  • action.addonConfiguration (string) – Пользовательская конфигурация плагина.

  • action.addonNamespace (string) – Пространство имен, в пределах которого выполняется действие над плагином.

  • action.createdAt (string) – Дата и время действия.

  • action.createdBy (string) – Идентификатор пользователя, который инициировал действие над плагином.

  • action.issues (array) – Список проблем, возникших при выполнении действия.

  • action.issues[].code (string) – Код возможных проблем.

  • action.issues[].message (string) – Содержание проблемы.

  • action.params (array) – Список параметров, используемых при выполнении действия над плагином.

  • action.params[].name (string) – Имя параметра.

  • action.params[].value (string) – Значение параметра.

  • action.status (string) – Статус действия.

  • action.type (string) – Тип действия над плагином.

PATCH /v2/clusters/{clusterId}/addons/{addonName}

Обновление существующего плагина на новую версию или применение новой конфигурации.

Parameters

  • clusterId (string) – Идентификатор кластера.

  • addonName (string) – Название плагина, например cilium.

Request JSON Object

  • addonConfiguration (string) – Пользовательская конфигурация плагина в JSON формате согласно схеме. Поддерживает переменные автоподстановки, заключенные в символы {{ и }}: - {{clusterID}} — уникальный идентификатор кластера; - {{clusterName}} — программное имя кластера; - {{productInstanceID}} — идентификатор экземпляра продукта; - {{nodeCIDR}} — CIDR сети узлов; - {{serviceCIDR}} — CIDR сервисной сети. Если значение не указано, то переиспользуется последняя конфигурация.

  • addonVersion (string) – Версия плагина в формате SemVer, на которую нужно обновиться.

  • resolveMode (string) – Режим разрешения конфликтов.

Status Codes

  • 200 OK – A successful response.

Response JSON Object

  • action (object) – Информация об обновлении плагина.

  • action.addonConfiguration (string) – Пользовательская конфигурация плагина.

  • action.addonNamespace (string) – Пространство имен, в пределах которого выполняется действие над плагином.

  • action.createdAt (string) – Дата и время действия.

  • action.createdBy (string) – Идентификатор пользователя, который инициировал действие над плагином.

  • action.issues (array) – Список проблем, возникших при выполнении действия.

  • action.issues[].code (string) – Код возможных проблем.

  • action.issues[].message (string) – Содержание проблемы.

  • action.params (array) – Список параметров, используемых при выполнении действия над плагином.

  • action.params[].name (string) – Имя параметра.

  • action.params[].value (string) – Значение параметра.

  • action.status (string) – Статус действия.

  • action.type (string) – Тип действия над плагином.

Запустили Evolution free tier
для Dev & Test
Получить