Аутентификация в API VMware Cloud Director

Для работы с API необходимо:

Запрос версий API

Получите актуальную версию API и URL для создание сессии.

Запрос

Отправьте GET-запрос на https://{SITE}/api/versions.

{SITE} — зависит от региона, в котором размещается ваш виртуальный ЦОД. Он отображается в ссылке на VMware Cloud Director https://{SITE}/tenant/my-tenant/. Ее мы отправляем при подключении услуги. Например, для региона PD01 параметр {SITE} принимает значение vcd01-01.cloud.ru, для PD11 — vcd11-01.cloud.ru.


Создание сессии

Примечание

Ниже рассмотрен способ создания сессии с помощью указания логина и пароля для доступа к тенанту. Вы также можете сгенерировать специальный токен API, чтобы не вводить учетные данные каждый раз при создании сессии. Подробнее — API Token.

Чтобы создать сессию и получить токен необходимо знать:

  • {VERSION} — номер версии API из предыдущего шага.

  • {LOGINURL} — URL для создания сессии из предыдущего шага.

  • tenant_name — название тенанта, которое можно посмотреть в URL-адресе для входа в VMware Cloud Director https://vcd01-01.cloud.ru/tenant/{tenant_name}.

  • user — логин для входа в VMware Cloud Director.

  • password — пароль для входа в VMware Cloud Director.

Данные для входа в VMware Cloud Director мы отправляем при подключении услуги.

Запрос

Отправьте POST-запрос на {LOGINURL}.


  • Basic / Basic Auth — тип утентификации.

  • {CREDENTIALS} — учетные данные для доступа к VMware Cloud Director в формате user@tenant_name:password в кодировке MIME Base64.

    Чтобы получить {CREDENTIALS} вы можете воспользоваться любым инструментом для перевода из текстового формата в MIME Base64.

Подсказка

Для формирования заголовка Authorization удобно использовать Postman, поскольку не нужно отдельно переводить данные в формат MIME Base64. На вкладке Authorization:

  1. В поле Type выберите «Basic Auth».

  2. В поле Username укажите логин и название тенанта в формате user@tenant_name.

  3. В поле Password укажите пароль.

Чтобы скопировать полученный заголовок Authorization, откройте код запроса.

Добавление токена в заголовок Authorization

Для последующих запросов в данной сессии добавьте в заголовок Authorization полученные токен и тип токена.


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

Код ошибки

Причина ошибки

Возможное решение

403: Forbidden

Срок действия токена истекает, если REST-клиент 30 минут не отправляет запросы. Ошибка указывает на то, что пользователь не авторизован или запрашиваемый объект не существует.

После истечения срока действия токена, создайте новую сессию. Если срок действия токена не истек, рекомендуем проверить наличие запрашиваемых объектов и правильность указания их идентификаторов в запросе.

См.также

Полное описание конечных точек, методов и параметров запросов можно посмотреть по ссылке https://{SITE}/docs/.

Облако VMware