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
VMware, Inc. 37
Chapter 3 Browsing
List the Contents of a vDC
TheresponseinExample 3‐1alsocontainsseveralVdcelements,eachofwhichrepresentsavDCobject.
Example 3‐4showsarequesttobrowseoneofthosevDCsandshowsasubsetoftheresponse.
Example 3-4. List the Contents of a vDC
Request:
GET http://vcloud.example.com/api/v1.0/vdc/5
Response:
200 OK
Content-Type: application/vnd.vmware.vcloud.vdc+xml
...
<Vdc name="ExampleVdc01" type="application/vnd.vmware.vcloud.vdc+xml"
href="http://vcloud.example.com/api/v1.0/vdc/5" ...>
<Link rel="up" type="application/vnd.vmware.vcloud.org+xml"
href="http://vcloud.example.com/api/v1.0/org/5"/>
<Link rel="add" type="application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml"
href="http://vcloud.example.com/api/v1.0/vdc/5/action/uploadVAppTemplate"/>
<Link rel="add" type="application/vnd.vmware.vcloud.media+xml"
href="http://vcloud.example.com/api/v1.0/vdc/5/media"/>
<Link rel="add" type="application/vnd.vmware.vcloud.instantiateVAppTemplateParams+xml"
href="http://vcloud.example.com/api/v1.0/vdc/5/action/instantiateVAppTemplate"
/>
<Link rel="add" type="application/vnd.vmware.vcloud.cloneVAppParams+xml"
href="http://vcloud.example.com/api/v1.0/vdc/5/action/cloneVApp"/>
<Link rel="add" type="application/vnd.vmware.vcloud.captureVAppParams+xml"
href="http://vcloud.example.com/api/v1.0/vdc/5/action/captureVApp"/>
<Link rel="add" type="application/vnd.vmware.vcloud.composeVAppParams+xml"
href="http://vcloud.example.com/api/v1.0/vdc/5/action/composeVApp"/>
<AllocationModel>AllocationPool</AllocationModel>
<Description>Example Corp. Primary vDC</Description>
<StorageCapacity>
<Units>MB</Units>
<Allocated>1000</Allocated>
<Limit>1000</Limit>
<Used>512</Used>
<Overhead>0</Overhead>
</StorageCapacity>
<ComputeCapacity>
<Cpu>
<Units>MHz</Units>
<Allocated>100</Allocated>
<Limit>100</Limit>
<Used>32</Used>
<Overhead>0</Overhead>
</Cpu>
<Memory>
<Units>MB</Units>
<Allocated>100</Allocated>
<Limit>100</Limit>
<Used>64</Used>
<Overhead>0</Overhead>
</Memory>
</ComputeCapacity>
<ResourceEntities>
<ResourceEntity href="http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-111"
type="application/vnd.vmware.vcloud.vAppTemplate+xml" name="Ubuntu
Template with vsftpd"/>
<ResourceEntity href="http://vcloud.example.com/api/v1.0/media/112"
type="application/vnd.vmware.vcloud.media+xml" name="Ubuntu Boot
Floppy"/>
<ResourceEntity href="http://vcloud.example.com/api/v1.0/media/113"
type="application/vnd.vmware.vcloud.media+xml" name="Ubuntu ISO Image"/>