1.5
Table Of Contents
- vCloud API Programming Guide
- Contents
- vCloud API Programming Guide
- About the VMware vCloud API
- Hello vCloud: A Simplified RESTful Workflow
- Exploring a Cloud
- Provisioning an Organization with vApps, Templates, and Media
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Retrieve or Update a Modifiable Section
- Update a vApp Network Configuration
- Update the NetworkConnectionSection of a Virtual Machine
- Retrieve or Modify the CPU Configuration of a Virtual Machine
- Retrieve or Modify the GuestCustomizationSection of a Virtual Machine
- Retrieve or Modify ProductSection Elements
- Retrieve or Modify Groups of Related Sections in a Virtual Machine
- Retrieve or Modify the Hard Disk Configuration of a Virtual Machine
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
n
param is an optional query parameter. Zero or more parameters are allowed. See “Query Parameters,” on
page 211.
n
filter is an optional filter expression. At most one filter expression is allowed. See “Filter Expressions,” on
page 212.
Query Types
Each query type returns its result set as an XML document in which objects are represented as elements and
object properties are represented as attributes, pairing the name of the property with its value at the time the
request was run. By default, result sets are returned in the records format, which shows all database records
for each object. Most queries also support the references format, which returns a set of object references,
including name, type, and href attributes. All queries that support the records format also support the
idrecords format. For more information about the format parameter, see “Query Parameters,” on page 211.
You can retrieve a summary list of all query types accessible to the currently authenticated user by making a
request list this one:
GET https://vcloud.example.com/api/query
If you make a query whose result set you do not have rights to view, a response code of
ACCESS_TO_RESOURCE_IS_FORBIDDEN (403) is returned.
Table 9-1. Query Types
Type Name Result Set User Admin
Syste
m Format
adminAllocatedExternalA
ddress
All allocated external IP addresses in the
system and the networks that use them
No No YES records,
idrecords
adminCatalog All catalogs in the system No No YES All
adminCatalogItem Catalog items in all catalogs in the system No No YES All
adminGroup Groups in all organizations in the system No No YES All
adminMedia All media in the system No No YES All
adminOrgNetwork All organization networks in the system No No YES All
adminOrgVdc All vDCs in the system No No YES All
adminShadowVM All shadow virtual machines in the system No No YES All
adminTask All active or recently completed tasks in the
system
No No YES All
adminUser Users in all organizations in the system No No YES All
adminVApp All vApps in the system No No YES All
adminVAppNetwork All vApp networks in the system No No YES All
adminVAppTemplate All vApp templates in the system No No YES All
adminVM All virtual machines in vApps or vApp
templates in the system
No No YES All
allocatedExternalAddress All allocated external IP addresses in your
organization and the networks that use them
No YES No records,
idrecords
blockingTask All active blocking tasks in the system No No YES All
catalog All catalogs in your organization that you have
rights to view or modify
YES YES No All
catalogItem All catalog items in your organization you
have rights to view or modify
YES YES No All
cell All vCloud Director cells supporting this cloud No No YES records,
idrecords
vCloud API Programming Guide
202 VMware, Inc.