1.0
Table Of Contents
- vCloud API Programming Guide
- Contents
- About This Book
- Introducing the VMware vCloud API
- Hello vCloud: A Structured REST Workflow Example
- Logging In and Getting an Organization List
- Browsing an Organization
- Finding a vApp Template
- Getting Information About a vDC
- Instantiating the Template in the vDC
- Deploying and Powering On the vApp
- Getting Information About the vApp
- Displaying the Console
- Deleting the vApp
- Logging Out
- Moving on to Additional Use Cases
- Browsing
- Provisioning
- Summary of Provisioning Requests
- Upload OVF to Create a vApp Template
- View the OVF Descriptor of a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving
- Changing a Name or Description
- Delete a vAppTemplate, vApp, or Media Image
- Cataloging vApp Templates and Media Images
- Controlling Access
- Datacenter Operations
- Summary of Datacenter Operations Requests
- vApp Lifecycle
- Instantiate a vApp Template
- Compose a vApp
- Recompose a vApp to Add or Remove Virtual Machines
- Capture a vApp to Create a vApp Template
- Reconfiguring vApps and Virtual Machines
- Deploying and Controlling vApps and Virtual Machines
- Deploy a vApp or Virtual Machine
- Undeploy a vApp or Virtual Machine
- Power On a vApp or Virtual Machine
- Power Off a vApp or Virtual Machine
- Reset a vApp or Virtual Machine
- Suspend a vApp or Virtual Machine
- Discard the Suspended State of a vApp or Virtual Machine
- Shut Down a vApp or Virtual Machine
- Reboot a vApp or Virtual Machine
- List Media Devices of a Virtual Machine
- Insert Media Into a Virtual Machine
- Eject Media from a Virtual Machine
- Get a Screen Thumbnail for a Virtual Machine
- Get a Screen Ticket for a Virtual Machine
- Provide User Input Requested by a Virtual Machine
- Control Access to vApps
- Retrieve a Task
- Administrative Operations
- VMware vSphere Platform Operations
- Summary of vSphere Platform Operations Requests
- List vSphere Platform Operations and Objects for a vCloud
- List Provider vDCs in a vCloud
- List External Networks in a vCloud
- List Network Pools in a vCloud
- List vCenter Servers Registered to a vCloud
- List ESX/ESXi Hosts in a vCloud
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- XML Representations in the vCloud API
- User API Reference
- Request Parameters Reference
- Administrative API Reference
- vSphere Platform Extensions Reference
- OVF and the vCloud API
- An Introduction to REST for vCloud API Users
- Index
vCloud API Programming Guide
142 VMware, Inc.
Schema Validation
ThisreleaseofCloudDirectorusesavalidatingXMLparserthatrequireselementsinXMLdocumentstoagree
inbothorderandnumberwiththeschema.Requiredelementsmustappearinrequestbodies.Allelements
thatappearinrequestbodiesmustappearintheorderestablishedbytheschema,andwith
contentthat
conformstothetypeconstraintspecifiedintheschema.Defaultvalues,wheredefined,aresuppliedfor
elementsthatareempty.
IfarequestcontainselementsfrommultipleXMLnamespaces,namespaceidentifiersmustbesuppliedin
requestbodiesandprependedtoelementnames.See“XMLNamespaceIdentifiers”onpage 145.
Content Type
AllrequeststhathaveabodymustincludeanHTTPContent‐Typeheaderthatspecifiesthecontenttypeof
thebody.Contenttypeshavebeendefinedforanyelementthatcanbeusedasarequestbody,andareshown
alongwiththeschemaandotherreferenceinformationfortheelement.
Object Reference Prototype
EveryobjectinavCloudisuniquelyidentifiedbyaURL.ThisURLisconstructedbytheserverandreturned
inthevalueofthehrefattributeoftheXMLelementthatrepresentstheobject.ItalsoappearsinvariousLink
andReferenceTypeelementsthatprovidereferencestotheobject.This
URLservesasauniqueidentifierthat
persistsforthelifeoftheobjectandisneverre‐used.WhenaclientmakesanHTTPGETrequesttoanobject
href,theserverreturnsthecurrentXMLrepresentationofthatobject.
AlthoughURLshaveawell‐knownsyntaxanda
well‐understoodinterpretation,aclientshouldtreateach
hrefasanopaquestring.Therulesthatgovernconstructionofhrefstringsbytheserverarenotguaranteed
toremainineffectinfuturereleases.Inthisrelease,theyyieldpredictablecontentthatconformstooneoftwo
prototypes:
Objectssuchasorganizations,vDCs,networks,andcatalogshavehrefvaluesoftheform
API‐URL/object‐type/id
ObjectssuchasvApptemplates,vApps,andVmshavehrefvaluesoftheformAPI‐URL/xxxxxx/yyy‐id
Foreachprototype,API‐URLhastheformhttp://vcloud.example.com/api/v1.0,andidisaninteger.An
objecthrefprototypeisincludedinthereferenceinformationforeachobjecttypethathasanhrefattribute.
Common Datatypes
ThevCloud APIusesanumberofprimitiveXMLdatatypes,asdefinedinW3CRecommendation28
(http://www.w3.org/TR/xmlschema‐2/).Italsodefinesanumberofcomplextypes,ofwhichvCloud API
elementsareinstances.
Primitive XML Datatypes
AttributesandsomeelementcontentarerepresentedbyprimitiveXMLdatatypes,whichareshownin
Table 8‐2.
N
OTEInthereferencematerial,elementsthataresimplycontainersarelistedbyname,alongwithan
explanationofthepurposeofthecontainer,butdonotincludeaschemareference.
Table 8-2. Primitive XML Data Types Used by the vCloud API
Value Description
xs:boolean Alogicalvalue,includingtrue,false,0,and1.
xs:date Datevalues.
xs:dateTime Date/timevalues(timestamps).
xs:double NumericvaluethatcorrespondstotheIEEEdouble‐precision64‐bitfloatingpointtype
definedinIEEE754‐1985.