В этом выпуске руководства по программированию API vCloud для сервис провайдеров предоставляется информация о версии 29.0 API vCloud.
VMware предоставляет множество различных API и SDK для приложений и целей. В этом руководстве представлена информация о API vCloud для разработчиков, которые заинтересованы в создании клиентов RESTful от VMware vCloud Director.
История редакций.
Номер версии API vCloud увеличивается при каждом изменении любого из его типов или операций. Руководство по программированию API vCloud для поставщиков услуг пересматривается с каждой версией VMware vCloud Director. Версии API vCloud, которые не были представлены в релизе VMware vCloud Director, описаны в Руководстве по программированию в среде Air Compute Service vCloud. Версия API может быть устарела всякий раз, когда более новая версия API поддерживает эквивалентный набор функций. Использование устаревшей версии API не рекомендуется. Поддержка версии API может быть удалена в выпуске после устаревания.
|
Revision Date |
Description |
Release Vehicle |
Status |
|---|---|---|---|
|
25 SEP 2017 |
API Version 29.0 |
vCloud Director 9.0 |
supported |
|
21 FEB 2017 |
API Version 27.0 |
vCloud Director 8.20 |
supported |
|
26 MAY 2016 |
API Version 20.0 |
vCloud Director 8.10 |
supported |
|
N/A |
API Version 19.0 |
vCloud Air Compute Service |
deprecated |
|
N/A |
API Version 18.0 |
vCloud Air Compute Service |
deprecated |
|
25 JAN 2016 |
API Version 17.0 |
vCloud Air Compute Service |
supported |
|
N/A |
API Version 16.0 |
vCloud Air Compute Service |
deprecated |
|
15 DEC 2015 |
API Version 14.0 |
vCloud Air Compute Service |
deprecated |
|
21 SEP 2015 |
API Version 13.0 |
vCloud Air Compute Service |
supported |
|
22 AUG 2015 |
API Version 12.0 |
vCloud Air Compute Service |
deprecated |
|
10 JUL 2015 |
API Version 11.0 |
vCloud Air Compute Service |
deprecated |
|
10 SEP 2015 |
API Version 9.0 |
vCloud Director 8.0, vCloud Air Compute Service |
supported |
|
15 APR 2015 |
API Version 7.0. |
vCloud Air Compute Service |
deprecated |
|
16 MAR 2015 |
API Version 6.0 |
vCloud Air Compute Service |
deprecated |
|
13 JAN 2015 |
API Version 5.11 |
vCloud Air Compute Service |
deprecated |
|
24 OCT 2014 |
API Version 5.10 |
vCloud Air Compute Service |
deprecated |
|
19 SEP 2014 |
API Version 5.9 |
vCloud Air Compute Service |
deprecated |
|
05 SEP 2014 |
API Version 5.8 |
vCloud Air Compute Service |
deprecated |
|
01 AUG 2014 |
API Version 5.7. |
vCloud Air Compute Service |
deprecated |
|
07 OCT 2014 |
API Version 5.6 |
vCloud Director 5.6 |
supported |
|
19 SEP 2013 |
API Version 5.5 |
vCloud Director 5.5 |
supported |
|
10 SEP 2012 |
API Version 5.1 |
vCloud Director 5.1 |
Deprecated. Unsupported after vCloud Director 9.0. |
|
01 SEP 2011 |
API Version 1.5 |
vCloud Director 1.5 |
Deprecated. Unsupported after vCloud Director 9.0. |
|
30 AUG 2010 |
API Version 1.0 |
vCloud Director 1.0 |
not supported |
|
14 APR 2010 |
API Version 0.9 |
N/A |
not supported |
Целевая аудитория
Данное руководство предназначено для разработчиков программного обеспечения, которые создают VMware Ready Cloud Services, включая интерактивных клиентов VMware vCloud Director. В этом руководстве обсуждаются соглашения о представлении состояний переноса (REST) и RESTful, спецификация Open Virtualization Format и технология виртуальной машины VMware. Вы должны быть знакомы с этими и другими широко распространенными технологиями, такими как XML, HTTP и операционная система Windows или Linux.
Связанные публикации
Ссылка Schema API vCloud включает справочный материал для всех элементов, типов, запросов и операций в API vCloud. Он также содержит файлы определения схемы. Ссылка на схему доступна на странице https://code.vmware.com
Руководство администратора VMware vCloud Director и Руководство пользователя VMware vCloud Director содержат подробную информацию о многих объектах и операциях, упомянутых в этом руководстве. Большинство пользователей API vCloud найдут информацию в тех документах, которые ценны при разработке клиентских приложений. Чтобы получить доступ к текущим версиям этих и других публикаций VMware, перейдите на страницу https://docs.vmware.com/
API VMware vCloud предоставляет поддержку разработчикам, которые создают интерактивные клиенты VMware vCloud Director, используя стиль разработки приложений RESTful.
Клиенты API vCloud взаимодействуют с серверами через HTTP, обмениваясь представлениями объектов vCloud. Эти представления принимают форму XML-элементов. Вы используете HTTP GET-запросы для извлечения текущего представления объекта, запросов HTTP POST и PUT для создания или изменения объекта, а HTTP DELETE - для удаления объекта.
Hello vCloud: упрощенный рабочий процесс RESTful
Клиенты API vCloud и серверы vCloud Director обмениваются данными через HTTPS, обмениваясь XML-представлениями объектов API vCloud.
Этот упрощенный пример рабочего процесса RESTful включает запросы, которые обнаруживают и развертывают конкретный vApp, в данном случае, FTP-сервер с подключением к общедоступному Интернету.
В этих примерах предполагается, что у вас есть доступ к каталогу, который включает шаблон vApp с определенными характеристиками и организацию, поддерживающую подключения к общедоступному Интернету. Рабочий процесс и примеры являются гибкими и могут вместить различные шаблоны vApp и облачные возможности.
Если вы хотите запустить примеры Hello vCloud, убедитесь, что выполнены следующие условия.
| ■ |
У вас есть учетные данные пользователя для пользователя с предопределенной ролью автора vApp или другой роль, которая имеет эквивалентный набор прав. |
| ■ |
Ваша организация содержит по крайней мере один VDC, который имеет по крайней мере одну сеть. Для получения информации о создании VDC и сетей см. в разделе Managing an Organization. |
| ■ |
Ваша организация содержит каталог, в котором доступен хотя бы один шаблон vApp. Сведения о добавлении шаблона vApp в каталог см. в разделе Provisioning an Organization. |
Процедура
| 1 |
To begin using the API, you request the system to create a Session object. In this request, you supply your credentials in an Authorization header of the form prescribed by the identity provider that your organization uses. The response includes an authorization token, which you must include in subsequent requests. |
| 2 |
Before you can deploy a vApp, you must find a vApp template in one of your organization's catalogs and a VDC in your organization to use for the deployment. |
| 3 |
You can make a GET request to a catalog URL to retrieve a list of vApp templates and media images referenced by the catalog. |
| 4 |
You can examine the list of items in a catalog to find items of interest based on the values of their name and type attributes. You must retrieve a catalog item to get a Description and a usable reference to the underlying object. |
| 5 |
To deploy your template as a vApp, you must specify an organization VDC to deploy it in and an organization VDC network to connect it to. |
| 6 |
To create a vApp from a vApp template, you must bind the template's abstract resource requirements, such as network connections, storage resources, memory, and CPU capacity, to appropriate resources in the target VDC. This binding operation is called instantiation. |
| 7 |
When you instantiate a vApp template, the server returns the URL of the resulting vApp. You can use this URL with a GET request to retrieve information that you can use to connect to the vApp, modify its configuration, and operate it. |
| 8 |
After a vApp is powered on, you can retrieve a screen ticket from any of its virtual machines. You use that ticket with the VMware HTML Console SDK to access the virtual machine console from a browser. |
| 9 |
After you undeploy a vApp and power it off, you can use an HTTP DELETE request to delete the vApp object. |
| 10 |
To log out and terminate a vCloud API session, delete the Session you created when you logged in. |
Исследуя облака
Вы можете использовать HTTP GET-запросы для просмотра контейнеров, таких как организации, каталоги и VDC в облаке.
Ответы на эти запросы включают метаданные о самом контейнере и ссылки на содержащиеся в нем объекты. Эти ссылки представлены в элементах Link, которые имеют атрибуты href, значения которых клиент может использовать в запросах для получения дополнительной информации об объектах. Этот процесс иногда называют последовательным обнаружением, потому что содержимое одного ответа предоставляет ссылки на места, где вы можете искать дополнительную информацию. Иерархическая структура объектов контейнера API vCloud поддается графическому представлению в виде иерархии папок или древовидного представления объектов API vCloud и позволяет клиентам использовать один и тот же набор объектов и операций для реализации подхода ширины или глубины к просмотру ,
Список точек входа, с которых вы можете начать просмотр, содержится в элементе Session, который возвращается в ответ на успешный вход в систему. Содержимое этого списка основано на вашей роли и привилегиях.
Create a vCloud API session
Retrieve a List of Organizations Accessible to You
Retrieve an Administrative View of a Cloud
Retrieve a List of vSphere Platform Operations and Objects for a Cloud
Связанные понятия
XML Representations in the vCloud API
Инициализация Организации
API vCloud предоставляет несколько способов сделать шаблоны vApp, vApps, мультимедийные изображения и независимые диски доступными для пользователей в организации vCloud Director.
API vCloud позволяет загружать и скачивать пакеты OVF и мультимедийные изображения в формате ISO. Операции характеризуются как загружаемые при передаче содержимого из клиентской системы API vCloud в целевой каталог в организации-клиенте vCloud и в виде загрузок, когда клиент API vCloud запрашивает передачу контента из vCloud Director. Запрос POST инициирует загрузку, а запрос GET инициирует загрузку. Служба передачи vCloud Director облегчает загрузку и загрузку и обеспечивает временное хранение файлов. Загруженные шаблоны vApp и мультимедийные изображения становятся доступными как элементы
каталога в целевом каталоге.
В дополнение к загрузке вы можете использовать следующие операции для обеспечения организации шаблонами vApp, vApps и медиа-изображениями:
|
Cloning |
The vCloud API cloneVApp operation creates a copy of a vApp in a specified VDC. You can specify whether to delete the source vApp after the operation completes. Deleting the source vApp after cloning it moves or renames it. |
|
Capturing |
The vCloud API captureVApp operation creates a vApp template from a vApp and places the template in a specified catalog. |
|
Importing |
A system administrator can import a virtual machine from a vCenter server that is registered to the cloud. You can import the virtual machine as a vApp or as a vApp template. You can add an imported template to a catalog or download it as an OVF package. |
|
Adopting |
In the default configuration, the system automatically discovers vCenter VMs contained by in any resource pool that backs an organization VDC. A system administrator can also can configure an organization VDC to adopt existing vCenter resource pools and the VMs they contain. The system administrator can make these discovered VMs available for adoption by organization members. |
|
Subscribing |
Organizations that have the appropriate permissions can create catalogs with external subscriptions. These contents of these catalogs are downloaded from a catalog hosted on another instance of vCloud Director, or any Web site that implements the VMware Content Subscription Protocol. See Create a Catalog With an External Subscription. |
Вы также можете создавать независимые диски, которые содержатся в организации VDC и могут быть подключены к любой виртуальной машине в этом VDC.
Развертывание и использование vApps и виртуальных машин
Объект vApp содержит одну или несколько виртуальных машин и предоставляет подробные спецификации этих виртуальных машин и сетей, к которым они подключаются. API vCloud поддерживает программный доступ к различным операциям центра обработки данных самообслуживания, которые позволяют пользователям создавать, настраивать, развертывать и управлять vApps.
Начальная конфигурация vApp и виртуальных машин, которые она содержит, устанавливается в пакете OVF, на котором основан его исходный шаблон. В API vCloud шаблоны vApp основаны на OVF 1.0. Эти шаблоны можно извлекать из каталогов и преобразовывать в виртуальные системы, называемые vApps, посредством процесса, называемого экземпляром, который связывает требования абстрактного ресурса шаблона к ресурсам, доступным в VDC.
После создания vApp с использованием любого из методов, описанных в разделе «О инстанцировании», вы можете внести дальнейшие изменения в свою конфигурацию, используя процедуры, подобные тем, которые показаны в разделе «Реконфигурация vApps и виртуальных машин». Все изменения конфигурации, которые вы делаете во время создания или реконфигурации, отбрасываются при удалении vApp, но вы можете сохранить их, захватив vApp в качестве шаблона. См. Захват vApp в качестве шаблона.
Про OVF
OVF является широко распространенным стандартным форматом, который применяется ко многим виртуализационным технологиям.
■ Виртуальные машины и устройства распространяются как пакеты OVF многими поставщиками.
■ Многие вендоры, включая VMware, предлагают инструменты, которые упрощают создание и настройку OVF, поддерживают преобразование виртуальных машин на существующие платформы виртуализации в OVF или и то, и другое.
■ OVF может выразить сложные отношения между виртуальными устройствами в корпоративных приложениях. Автор устройства может обрабатывать большую часть сложности, а не пользователя, который его развертывает.
■ OVF расширяема, позволяя вносить новые политики и требования в ISV и внедряться платформами виртуализации, которые поддерживают их, не требуя изменений для других клиентов, других платформ или самого API vCloud.
Администраторы и продвинутые пользователи должны ознакомиться с деталями стандарта OVF до разработки приложений с помощью API vCloud. Полный технический документ OVF доступен по адресу http://www.dmtf.org/standards/published_documents/DSP0243_1.0.0.pdf. Информационный документ об OVF доступен по адресу http://www.dmtf.org/standards/published_documents/DSP2017_1.0.0.pdf.
Виртуальная машина обычно состоит из одного или нескольких файлов виртуальных дисков, которые содержат операционную систему и приложения, которые запускаются на виртуальной машине, и файл конфигурации, содержащий метаданные, описывающие, как виртуальная машина настроена и развернута. Пакет OVF включает эти компоненты, а также дополнительные файлы сертификатов и манифеста. Пакет можно распространять и хранить в виде набора отдельных файлов или в виде файла одного архива (OVA). API vCloud не поддерживает загрузку или загрузку файлов OVA.
Про DMTF, CIM и RASD
Виртуальное оборудование в элементах OVF-пакетов определяется с использованием открытой стандартной структуры, установленной целевой группой распределенного управления (DMTF). Эта структура, называемая общей информационной моделью (CIM), определяет виртуальные аппаратные ресурсы, используя схему ResourceAllocationSettingData (RASD). В этой схеме каждый класс виртуального оборудования представлен как элемент Item с определенным типом ResourceType. Многие операции API vCloud, которые развертывают и настраивают vApps и виртуальные машины, требуют от вас понимания и иногда изменения элементов элемента RASD.
Вы можете загрузить файлы схемы RASD и соответствующую информацию из http://www.dmtf.org/standards/cim/cim_schema_v2191
Жизненный цикл vApp
VApp содержит один или несколько элементов Vm, которые представляют собой отдельные виртуальные машины. Он также содержит информацию, которая определяет рабочие данные для vApp и виртуальных машин, которые он содержит. Жизненный цикл vApp включает несколько различных состояний:
■ OVF-пакет, форма, в которой vApps обычно распределяются.
■ Шаблон vApp, созданный, когда клиент загружает пакет OVF в каталог.
■ Undeployed vApp, созданный при создании экземпляра шаблона vApp без развертывания, или развернутый vApp не развернут.
■ Развернутый vApp, готовый к включению и управлению. Инстанцирование может включать развертывание, включение питания или и то, и другое.
