1.5
Table Of Contents
- vCloud API Programming Guide
- Contents
- vCloud API Programming Guide
- About the VMware vCloud API
- Hello vCloud: A Simplified RESTful Workflow
- Exploring a Cloud
- Provisioning an Organization with vApps, Templates, and Media
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Retrieve or Update a Modifiable Section
- Update a vApp Network Configuration
- Update the NetworkConnectionSection of a Virtual Machine
- Retrieve or Modify the CPU Configuration of a Virtual Machine
- Retrieve or Modify the GuestCustomizationSection of a Virtual Machine
- Retrieve or Modify ProductSection Elements
- Retrieve or Modify Groups of Related Sections in a Virtual Machine
- Retrieve or Modify the Hard Disk Configuration of a Virtual Machine
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
Summary of vCloud API Provisioning Requests
Provisioning requests add vApp templates and media to a vDC and a catalog. You can also use provisioning
requests to copy, move, rename, and delete these objects.
n
API-URL is a URL of the form https://vcloud.example.com/api.
n
id is a unique identifier in the form of a UUID, as defined by RFC 4122.
Request URLs are always available when you GET the representation of the object on which they operate. URL
forms are for reference purposes only. For more information about the requests and responses for each
operation, see “About the Schema Reference Downloadable Archive,” on page 19.
Table 4-1. Summary of Provisioning Requests
Operation Request Request Body Response
Upload OVF to create a vApp
template.
POST API-URL/vdc/id/
action/uploadVAppTempla
te
UploadVAppTemplatePara
ms
VAppTemplate
Download a vApp template
as OVF.
GET download-URL None Depends on file type
Enable a vApp template for
download.
POST API-
URL/vAppTemplate/
vAppTemplate-
id/action/enableDownload
None
Task
Disable a vApp template for
download.
POST API-
URL/vAppTemplate/
vAppTemplate-
id/action/disableDownload
None 204 No Content
Upload a media image. POST API-
URL/vdc/id/media
Media Media
Copy or move a media image. POST API-
URL/vdc/
id/action/cloneMedia
CloneMediaParams Media
Copy or move a vApp
template.
POST API-
URL/vdc/id/action/
cloneVAppTemplate
CloneVAppTemplateParam
s
VAppTemplate
Copy or move a vApp. POST API-
URL/vdc/
id/action/cloneVApp
CloneVAppParams VApp
Change the name or
description of a vApp
template.
PUT API-
URL/vAppTemplate/vappT
emplate-id
VAppTemplate Task
Change the name or
description of a vApp.
PUT API-URL/vApp/vapp-
id
VApp Task
Change the name or
description of a media image.
PUT API-URL/media/id
Media Task
Delete a vApp template,
vApp, or media image.
DELETE object-URL None
Task
Add an item to a catalog. POST API-
URL/catalog/
id/catalogItems
CatalogItem CatalogItem
Remove an item from a
catalog.
DELETE API-URL/
catalog/id/catalogItem/id
None 204 No content
vCloud API Programming Guide
54 VMware, Inc.