- tocdepth
2
API (консоль управления)
В этом разделе — вводная информация для работы c API VMware Cloud Director. Вы узнаете об основных принципах работы с API, сможете пройти аутентификацию и выполнить несколько простых запросов.
Данный документ не является справочником по API.
Полное описание конечных точек, методов и параметров запросов можно посмотреть по ссылке https://{SITE}/docs/.
{SITE} — зависит от региона, в котором размещается ваш виртуальный ЦОД.
Он отображается в ссылке на VMware Cloud Director https://{SITE}/tenant/my-tenant/.
Ее мы отправляем при подключении услуги.
Например, для региона PD01 параметр {SITE} принимает значение vcd01-01.cloud.ru, для PD11 — vcd11-01.cloud.ru.
Для знакомства с API предлагаем выполнить следующие шаги:
Инструменты для создания тестовых запросов
Для выполнения тестовых запросов из этого раздела вы можете использовать cURL, Postman или другие инструменты.
Особенности API
API позволяет взаимодействовать с VMware Cloud Director через REST-клиент. REST-клиенты обмениваются с сервером XML-представлениями объектов VMware Cloud Director по протоколу HTTP.
Доступные методы:
GET— получить представление объекта;POST— создать объект;PUT— изменить объект;DELETE— удалить объект.
Для работы с REST-клиентом нужно понимать:
HTTP.
Cемантику XML.
Структуру XML-представлений объектов VMware Cloud Director и значение элементов и атрибутов на XML-схеме организации.
Связь объектов, с которыми работает API: организации, виртуальные ЦОД, vApp, VM, каталоги, пользователи и др.
Принцип работы REST-клиента с XML-представлениями объектов.
API использует уникальные идентификаторы (universal unique identifiers, UUID), определенные в RFC 4122. В руководстве они заменены на упрощенные варианты, например:
vapp-f5e185a4-7c10-41f1-8с91-0e662d538101заменяется наvapp-{VAPP-ID}илиvapp-f5e185...;org/89a1a8f3-c518-5f53-940c-950df6e3заменяется наorg/{ORG-ID}илиorg/89a1a8....
для Dev & Test