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
XML Namespace Identifiers
A response typically includes all the XML namespace identifiers that the server uses to validate it, in
addition to other attributes that specify the schema locations searched during validation.
The following fragment shows the attributes and prefixes of the XML namespace identifier that appear in a
typical response for the vCloud Air Platform APIs:
<Session
...
xmlns="http://www.vmware.com/vchs/v5.6"
xmlns:tns="http://www.vmware.com/vchs/v5.6"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
</Session>
Overview of Object Types
The vCloud Air Platform APIs define a set of objects common to cloud computing environments. An
understanding of these objects is essential to using the APIs.
The following conventions apply to the objects you access through the APIs:
n
List types follow these conventions; for example, an object named Obj :
n
Uses ObjListType as the XSD type definition.
n
Contains objlist in the media type.
n
Has Objs as the element name.
n
Top level elements of objects in responses extend from EntityType.
n
The short versions of objects typically are included in other object responses extended from
ReferenceType.
The following table describes all the object types in the vCloud Air Platform APIs.
Table 1‑1. Object Type Descriptions
Object Type Description Class Value
SessionType
Provides a return type from a login. Contains a link
to retrieve the list of compute services.
vnd.vmware.vchs.session
ServiceListType
Contains a list of services purchased by the
requesting customer account. Entries in the list are
ServiceType.
vnd.vmware.vchs.servicelist
ServiceType
Represents a reference to service meta data for
vCloud Air. Currently, the ServiceType object
type includes Dedicated Cloud and
Virtual Private Cloud meta data. ServiceType is a
lightweight object, which contains the name, an
href to Compute, the type of service
(compute:dedicatedcloud or compute:vpc), the
serviceId (assigned by VMware when your
vCloud Air account is provisioned) and the
geographical region of the service (for example, "US
- Santa Clara ").
vnd.vmware.vchs.service
vCloud Air Platform Programmer's Guide
8 VMware, Inc.