5.6
Table Of Contents
- vCloud Air Platform Programmer's Guide
- Contents
- About this Programmer's Guide
- About the vCloud Air Platform APIs
- The VMware APIs for Cloud Automation
- XML Namespace Identifiers
- Overview of Object Types
- Link Relationships in the Object Types
- API Versioning
- Roles for the APIs for Cloud Automation
- Authentication and Authorization
- vCloud Air Platform APIs Schema Reference
- Java Code Samples for Cloud Automation
- About the Examples in this Programmer's Guide
- Hello vCloud Air : A RESTful Workflow
- Index
n
Creates a virtual machine by using a template, powers on the virtual machine, and obtain its IP address
for subsequent connections. Then, runs a Web service on that virtual machine. To run this code sample,
you must log in as a user assigned to one or more of the following roles: Virtual infrastructure
administrator or End User.
n
Adds a NAT rule to enable external HTTPS requests to a Web service running on a virtual machine in
the virtual data center and adds a firewall rule to prevent all other access. To run this code sample, you
must log in as a user assigned to the Virtual infrastructure administrator role.
The code samples support the standard use case wherein a company purchases by logging in to
My VMware both Virtual Private Cloud and Dedicated Cloud capacity in different regions of vCloud Air. A
vCloud Air Account Administrator logs in to the vCloud Air Web UI to create a user and assign that user to
an appropriate access role.
Additionally, the code samples illustrate how to establish a vCloud session, request the vCloud instance
version, and set the correct version header.
The code samples are available for download from the VMware Community > VMware Technology
Network (VMTN) Forums > VMware Developer > Sample Code at
https://communities.vmware.com/community/vmtn/developer/codecentral.
About the Examples in this Programmer's Guide
The examples in this guide of HTTP requests and responses illustrate the workflow and content that is
associated with automating login to vCloud Air and session set up for vCloud to obtain virtual data center
information.
Example request headers follow these conventions:
n
Header names and values are case-insensitive, and can be submitted or returned in any character case.
n
Other HTTP headers, such as date, content-length, and server, are omitted because they are not relevant
to the specifics of any example.
n
The XML version and encoding header <?xml version="1.0" encoding="UTF-8"?> is omitted in
example requests.
Example responses follow these conventions:
n
Responses show only those elements and attributes that are relevant to the operation being explained.
Ellipses (…) indicate omitted content within responses.
n
The XML version and encoding header <?xml version="1.0" encoding="UTF-8"?> is omitted in
example responses.
n
Object IDs shown in href attribute values appear as small integers, for example vchs-2 for compute-uuid
or vdc-7 for vdc-uuid. In the API, object IDs are universal unique identifiers (UUIDs) as defined by RFC
4122, for example f5e185a4-7c00-41f1-8b91-0e552d538101.
Chapter 1 About the vCloud Air Platform APIs
VMware, Inc. 13