Справочник API

Введение

Примечание

Чтобы скачать спецификацию API, перейдите по ссылке Спецификация API

API Sharx Base 6 — справочник запросов для Платформы Sharx Base, в котором описаны доступные методы и способы их применения.

Методы API разделены на несколько категорий:

Auth — аутентификация и авторизация;
Cluster — управление кластером;
Metrics — получение метрик работы кластера;
Plugin — взаимодействие с плагинами.

Часто используемые методы

На практике наиболее часто используемыми методами являются:

Получить токен аутентификации
```
/api/v1/auth
```
Взаимодействовать с плагинами
```
/api/v1/cluster/{cluster}/plugins/{plugin}
```

Пример запроса

Примечание

Примеры API-запросов о доступных ресурсах приведены в статье Получить информацию о ресурсах

Чтобы выполнить определенную операцию в вызванном плагине, необходимо указать параметры в теле запроса.

Пример запроса списка ресурсов будет выглядеть следующим образом:

Вызов списка ресурсов

PUT /api/v1/cluster/{cluster}/plugins/scheduler  # Вызов плагина scheduler
body                                             # Тело запроса с параметрами
{
     "context": {
          "op": "request_list"                      
     },
     "data": {
     "vcluster": "<vcluster>"
     }
}

где

{cluster} — имя кластера;
<vcluster> — имя виртуального кластера.

Параметры тела запроса

Подробное описание параметров тела запроса для каждого плагина приведено в следующих статьях:

sdc-plgn-aaa — идентификация, аутентификации и управления доступом.
sdc-plgn-aaaevents — регистрация событий.
sdc-plgn-goss — проверка корректности настроек узлов виртуализации кластера.
sdc-plgn-hardware — сбор информации об аппаратном обеспечении узлов виртуализации, на которых развернута Sharx Base.
sdc-plgn-ipam — работа с сетевым стеком (виртуальные сети, OFC, программный коммутатор).
sdc-plgn-lic — работа с лицензиями. Управление лицензионными ключами.
sdc-plgn-logdump — резервное копирование журналов событий, настроек кластера и виртуальной инфраструктуры.
sdc-plgn-metrics — работа с локальными метриками для мониторинга системы
sdc-plgn-notif — работа с уведомлениями.
sdc-plgn-scheduler — планирование ресурсов кластера и механизм управления виртуальной инфраструктурой
sdc-plgn-services — старт или остановка системных сервисов на узлах виртуализации кластера.
sdc-plgn-signer — контроль целостности компонентов виртуальной инфраструктуры и работы с сертификатами.
sdc-plgn-storage — работа с хранилищем данных.
sdc-plgn-updater — обновление компонентов.

API Sharx Base 6

Примечание

Справочник доступен только на английском языке