VK Private Cloud logo
Помощь
Обновлена 31 июля 2026 г. в 18:08

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

Некоторые операции на Платформе выполняются только с помощью REST API.

HTTP и HTTPS запросы к REST API по умолчанию будут работать с деплой-ноды и/или управляющего узла. Для того чтобы они работали из других подсетей необходимо открыть доступ из них (Firewall и маршрутизация).

Получение токена авторизации

Перед выполнением запроса к REST API Платформы требуется получение токена аутентификации.

Получить токен аутентификации можно на Портале самообслуживания:

  1. Выполните вход на Портал самообслуживания с учетными данными пользователя Платформы.
  2. Нажмите на имя пользователя в шапке страницы и выберите пункт Настройки проекта.
  3. Перейдите на вкладку Доступ по API.
  4. Скопируйте значение параметра Токен для доступа к API.
OpenStack CLI
TOKEN=$(openstack token issue -c id -f value)
Пример использования токена авторизации в запросах
# curl -X POST -H "X-Auth-Token: <ТОКЕН>" <ЗАПРОС>

Здесь:

  • <ТОКЕН> — значение параметра Токен для доступа к API.
  • <ЗАПРОС> — текст запроса.

Перевыпуск токена авторизации

После завершения времени действия перевыпустить токен авторизации можно на Портале самообслуживания:

  1. Выполните вход на Портал самообслуживания с учетными данными пользователя Платформы.
  2. Нажмите на имя пользователя в шапке страницы и выберите пункт Настройки проекта.
  3. Перейдите на вкладку Доступ по API.
  4. В нижней части экрана нажмите кнопку Перевыпустить.

Точка доступа сервиса (Endpoints)

Чтобы получить точки доступа к API, используйте один из интерфейсов:

  • Портал самообслуживания.
  • OpenStack CLI.

Портал самообслуживания

  1. Выполните вход на Портал самообслуживания с учетными данными пользователя Платформы.
  2. Нажмите на имя пользователя в шапке страницы и выберите пункт Настройки проекта.
  3. Перейдите на вкладку API Endpoints.
  4. Скопируйте значение параметра Точка доступа сервиса.

OpenStack CLI

  1. Подключитесь к OpenStack CLI (подробнее — в разделе Подключение к OpenStack CLI).

  2. Выполните команду:

    $ openstack catalog list