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
Hello vCloud Air : A RESTful
Workflow 2
vCloud Air clients and servers communicate over HTTPS, exchanging XML representations of vCloud API
objects. This simplified example of a RESTful workflow includes logging in to vCloud Air, requesting
service details from vCloud, and creating a vCloud session to obtain the list of virtual data centers for that
compute service.
These examples assume that you have you have subscribed to vCloud Air, have created a user account, and
have at least one virtual data center in the Compute Service.
1 Log in to vCloud Air on page 15
vCloud Air requires login requests to be authenticated. Begin the workflow with a login request that
supplies user credentials in the MIME Base64 encoding format as specified in RFC 1421.
2 Create a Session for a Virtual Data Center in a Service on page 18
When you log in to vCloud Air, you retrieve the Services element, which contains elements for each
Compute Service your company has purchased for vCloud Air. Each Service element in the list
contains a reference to the service.
3 Log Out on page 23
To log out and end a vCloud Air session, delete the session you created when you logged in. The
logout request, like all other authenticated requests, must include the Authorization header.
Log in to vCloud Air
vCloud Air requires login requests to be authenticated. Begin the workflow with a login request that
supplies user credentials in the MIME Base64 encoding format as specified in RFC 1421.
Prerequisites
n
Your company has purchased Virtual Private Cloud or Dedicated Cloud capacity in different regions of
vCloud Air via My VMware and obtained an Account Administrator login on vCloud Air (procured
directly through My VMware).
n
Your Account Administrator has created at least one user account with credentials in the vCloud Air.
n
You are a user assigned to a role that can access the API.
n
You are a user assigned to a role that can access your compute services.
As a vCloud Air client, you present your credentials one time to log in and view the list of your subscribed
compute services in vCloud Air.
VMware, Inc.
15