Шлюзы vStack Serverspace

by Serverspace

Управляйте пограничными шлюзами vStack, подключёнными изолированными сетями и наборами правил Firewall/NAT.

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

Что делает API

API шлюзов охватывает список и детали шлюза, создание, изменение имени, удаление, питание, пропускную способность, подключение изолированных сетей, теги и правила Firewall/NAT. Создание требует указать изолированные сети; изменение наборов правил заменяет текущий набор целиком. Правила Firewall применяются последовательно, приоритет получает последнее совпавшее.

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

  • Получить шлюз проекта и посмотреть подключённые сети до изменения NAT/Firewall.
  • При создании пограничного шлюза сразу указать изолированные сети, затем настроить полный набор NAT/Firewall правил.
  • Поменять пропускную способность канала или питание и отслеживать выданную задачу.

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

Авторизация
Передавайте API-ключ проекта в заголовке X-API-KEY; OpenAPI также поддерживает Bearer OAuth. Права для методов раздела: VstackCloud/View, VstackCloud/Edit. Для OAuth используются разрешения: vstack:view, vstack:edit.
Что учесть
При создании укажите подключаемые изолированные сети. PUT Firewall/NAT заменяет весь массив правил; пустой массив удаляет все правила. В Firewall последнее совпавшее правило приоритетно.

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

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

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

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

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

  1. Получить список шлюзов и выбрать location_id/gateway_id.
  2. Для создания подготовьте список изолированных сетей. Для изменения Firewall или NAT сначала прочитайте текущие правила, затем отправьте полный желаемый массив через PUT.
  3. Дождитесь завершения операций, вернувших task_id, и перечитайте конфигурацию. Проверьте доступность нужных соединений после применения правил.

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

  • PUT Firewall/NAT удаляет прежний набор и создаёт переданный; пустой массив стирает все правила.
  • В firewall приоритет имеет последнее подходящее правило, поэтому проверьте порядок массива.
  • Создание шлюза требует указать подключаемые изолированные сети; подтвердите нужные location_id и gateway_id.

Связанные API