5.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
- Summary of vCloud API Browsing Requests
- Retrieve the Login URL and List of Supported API Versions
- Create a Login Session Using the Integrated Identity Provider
- 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
- Provisioning an Organization
- Summary of vCloud API Provisioning Requests
- Upload an OVF Package to Create a vApp Template
- Download a vApp or vApp Template as OVF
- Upload a Media Image
- Download a Media Image
- Capturing and Importing vApps
- Managing Catalog Items
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- Controlling Access to vApps and Catalogs
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Create a vApp From an OVF Package
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Clone a vApp
- Capture a vApp as a Template
- Update vApp Access Controls
- Provide User Input Requested by a Virtual Machine
- Attach or Detach an Independent Disk
- Creating and Using vApp Snapshots
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Update Multiple Sections of 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
- Update the Storage Profile for a Virtual Machine
- Creating and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- VDC Administration
- Network Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Managing and Monitoring a Cloud
- Summary of System Administration Requests
- Retrieve or Update System Settings
- Attach a vCenter Server
- Finding Available vCenter Resources
- Create a Provider VDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- Relocate a Virtual Machine to a Different Datastore
- Truststore and Keytab Maintenance
- Retrieve the vSphere URL of an Object
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- vCloud Director Extension Services
- XML Representations in the vCloud API
- Index
Table 4‑1. Summary of Provisioning Requests (Continued)
Operation Request Request Body Response
Move a catalog item. [NEW] POST API-
URL/catalogItem/id/
action/move
CopyOrMoveCatalogItemP
arams
Task
Copy a catalog item. [NEW] POST API-
URL/catalogItem/id/
action/copy
CopyOrMoveCatalogItemP
arams
Task
Synchronize a catalog with
its remote source. [NEW]
POST API-URL/catalog/id/
action/sync
None
Task
Synchronize a catalog item
with its remote source.
[NEW]
POST API-
URL/catalogItemid/
action/sync
None
Task
Copy or move a media
image. [DEPRECATED]
POST API-
URL/vdc/id/action/cloneMe
dia
CloneMediaParams Media
Copy or move a vApp
template. [DEPRECATED]
POST API-
URL/vdc/id/action/
cloneVAppTemplate
CloneVAppTemplateParam
s
VAppTemplate
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 media
image.
PUT API-URL/media/id
Media Task
Delete a vApp template,
vApp, or media image.
DELETE object-URL None
Task
Synchronize a catalog with
its external source. [NEW]
POST API-
URL/catalog/id/action/sync
None
Task
Synchronize a catalog item
with its external source.
[NEW]
POST API-
URL/catalogItem/id/actio
n/sync
None
Task
Add an item to a catalog.
[DEPRECATED]
POST API-
URL/catalog/id/catalogItem
s
CatalogItem CatalogItem
Remove an item from a
catalog.
DELETE API-URL/
catalog/id/catalogItem/id
None 204 No content
Control access to catalogs. POST API-
URL/catalog/id/action/contr
olAccess
ControlAccessParams ControlAccessParams
Retrieve the owner of a
media object.
GET API-
URL/media/id/owner
None
Owner
Retrieve the owner of a
vApp template.
GET API-
URL/vAppTemplate/vappT
emplate-id/owner
None
Owner
Retrieve the owner of a
vApp.
GET API-
URL/vApp/id/owner
None
Owner
Update the owner of a
vApp.
PUT API-
URL/vApp/id/owner
Owner
204 No Content
Create an independent disk
in a VDC.
POST API-URL/vdc/id/
disk
DiskCreateParams Disk
Chapter 4 Provisioning an Organization
VMware, Inc. 57