Попробовать

API

В этом разделе — вводная информация для работы с VMware Cloud Director API. Вы узнаете об основных принципах работы с API, сможете авторизоваться и выполнить несколько простых запросов.

Данный документ не является справочником по VMware Cloud Director API. Полное описание конечных точек, методов и параметров запросов представлено в документации VMware.

Для знакомства с VMware Cloud Director API предлагаем выполнить следующие шаги:

Инструменты для создания тестовых запросов

Для выполнения тестовых запросов из этого раздела вы можете использовать cURL, Postman или другие инструменты.

Особенности VMware Cloud Director API

VMware Cloud Director 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-представлениями объектов.

VMware Cloud Director 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....