Справочники серверов vStack Serverspace

by Serverspace

Получайте список локаций, образов и приложений vStack, чтобы подготовить параметры заказа сервера.

⚙️ Администрирование
Компания
Serverspace
Сайт компании
serverspace.ru ↗
Адрес API
https://api.serverspace.ru ↗

Что делает API

Справочные методы возвращают доступные локации, шаблоны образов и приложения для серверного API vStack. Они помогают выбрать допустимые значения для заказа/настройки сервера, но сами серверы не создают. Справочники VMware вынесены в отдельные /api/v1/vmware/... маршруты и могут иметь другой набор значений.

Когда использовать

  • Перед заказом vStack получить локации, лимиты и доступность, затем выбрать подходящую локацию.
  • Получить шаблоны образов и приложения, чтобы сформировать допустимые параметры серверной конфигурации.

Подключение и ограничения

Авторизация
Передавайте API-ключ проекта в заголовке X-API-KEY; OpenAPI также поддерживает Bearer OAuth. Права для методов раздела: VstackCloud/View. Для OAuth используются разрешения: vstack:view.
Что учесть
Справочник locations содержит допустимые конфигурации и текущие флаги доступности создания ресурсов. Значение false у соответствующего allow_* означает, что создание сейчас закрыто; нулевые пределы дисков или канала означают неопределённое значение, а не разрешение на нулевой ресурс.

Пример использования

Подготовьте доступ по инструкции выше и замените параметры своими. Пример не выполняется на этой странице.

# Задайте SERVERSPACE_API_KEY: API-ключ нужного проекта.
curl --fail-with-body --request GET \
  --url "https://api.serverspace.ru/api/v1/locations" \
  --header "X-API-KEY: ${SERVERSPACE_API_KEY:?Укажите API-ключ проекта}"
Результат
Каждый справочный GET возвращает коллекцию своего типа: locations, images или applications. Это синхронные чтения без идентификатор задачи.
Ошибки
401 — ключ отсутствует или недействителен; 403 — недостаточно прав для выбранной операции или ресурса проекта. Сверьте требуемое разрешение в документации метода.

Сверено с документацией: .

Порядок интеграции

  1. Запросить GET /locations и проверить доступность создания в требуемой локации.
  2. Получить GET /images и /applications; использовать значения из этих справочников при формировании отдельного запроса сервера.
  3. Если создание не проходит, обновить справочник и повторно проверить доступность, а не считать GET операцию бронированием.

Что проверить перед запуском

  • Справочник локаций включает лимиты дисков/канала, конфигурации и доступность создания; не трактуйте его как резерв ресурсов.
  • Методы раздела синхронно возвращают справочные объекты и требуют только View.
  • Используйте vStack справочники для /api/v1/servers; VMware имеет свои /api/v1/vmware/... каталоги.

Связанные API