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
Routing key components include:
operationSuccess
A Boolean value denoting whether the operation that triggered the notification
succeeded or failed.
entity
The object identifier of the object on which an operation, an event of type
com/vmware/vcloud/event/, triggered the notification. For more information
about object identifiers, see “Objects, References, and Representations,” on
page 11
org
The object identifier of the organization that owns the affected object.
user
The object identifier of the user who made the request.
subType1-subTypeN
Each subType is a single component of the event type name. See “Notification
Types,” on page 221.
taskName
If entity is a task or blocking task, the task name is appended to the routing key.
The following routing key, in which the object identifiers are truncated to save space, is an example of a routing
key that might have been created for a successful com/vmware/vcloud/event/vapp/create event:
true.dc6a-
xxx
.0b8a-
xxx
.832c-
xxx
.com.vmware.vcloud.event.vapp.create
Notification Headers
The vCloud API defines notification headers and prepends them to every notification.
Table 10-1. Notification Headers
Header Value
notification.type See “Notification Types,” on page 221.
notification.entityType The type of vCloud entity is associated with this notification.
For example, vm.
notification.entityUUID The object identifier of the object on which an operation, an
event of type com/vmware/vcloud/event/, triggered the
notification.
notification.orgUUID The object identifier of the organization that owns the
affected object.
notification.userUUID The object identifier of the user who made the request.
notification.operationSuccess A Boolean value denoting whether the operation that
triggered the notification succeeded or failed.
Example: Notification Message Format
In addition to the routing key, a notification message contains a Notification element. This one was generated
by a blocking task.
<vmext:Notification
xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
type="com/vmware/vcloud/event/blockingtask/create"
eventId="a1440dd8-60ae-46c7-b216-44693bc00c90">
<vmext:Link
rel="entityResolver"
href="https://vcloud.example.com/api/entity/" />
<vmext:EntityLink
rel="entity"
type="vcloud:blockingTask"
vCloud API Programming Guide
220 VMware, Inc.