VMware VCLOUD API 1.0 - API - Datacenter Operations

VMware, Inc. 59
5
ThevCloudAPIsupportsprogrammaticaccesstoarangeofself‐servicedatacenteroperationsthatallowusers
tocreate,configure,operate,andconnecttovApps.
Thischapterincludesthefollowingtopics:
 “SummaryofDatacenterOperationsRequests”onpage 59
 “vAppLifecycle”onpage 60
 “InstantiateavAppTemplate”onpage 61
 “ComposeavApp”onpage 65
 “RecomposeavApptoAddorRemoveVirtualMachines”onpage 67
 “CaptureavApptoCreateavAppTemplate”onpage 68
 “ReconfiguringvAppsandVirtualMachines”onpage 69
 “DeployingandControllingvAppsandVirtualMachines”onpage 80
 “ControlAccesstovApps”onpage 89
 “RetrieveaTask”onpage 89
Summary of Datacenter Operations Requests
Table 5‐1summarizesdatacenteroperationsrequestssupportedinthisrelease.Thetableusesthefollowing
conventions:
 API‐URLisaURLoftheformhttp://vcloud.example.com/api/v1.0
 idisaninteger
 vApp‐or‐Vm‐URLisaURLoftheformAPI‐URL/vApp/vapp‐id(foravAppobject)or
API‐URL/vApp/vm‐id(foraVmobject)
Datacenter Operations
5
Table 5-1. Summary of Datacenter Operations Requests
Operation Request Request Body Response
InstantiateavAppTemplate POSTAPI‐URL/vdc/id/action/
instantiateVAppTemplate
InstantiateVAppTemplateParams VApp
RetrievevAppTemplate
CustomizationSection
GETAPI‐URL/vAppTemplate/
vappTemplate‐id/
customizationSection
None CustomizationSection
ModifyvAppTemplate
CustomizationSection
PUTAPI‐URL/vAppTemplate/
vappTemplate‐id/
customizationSection
CustomizationSection Task
ComposeavApp POSTAPI‐URL/vdc/id/action/
composeVApp
ComposeVAppParams VApp