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
Using the Query Service 9
You can use the vCloud API query service to query the vCloud Director database for information about objects
in the cloud.
The query service provides the following kinds of queries:
n
Typed queries, which require you to construct a query URL that specifies a query type and optional
parameters.
n
Packaged queries, which have well-known URLs and can accept many of the same parameters used with
typed queries.
Both typed and packaged queries allow you to specify one of the following formats in which to display the
result set:
n
A records format that returns name=value pairs for all properties of each matching object. This is the default.
n
An idrecords format that is identical to the records format, except that object references are returned in
id format rather than href format. See “Objects, References, and Representations,” on page 11.
n
A references format that returns a reference in href format to each object that matches the query criteria.
Query results are paginated, and include links to previous and next pages where needed. Page size can be
specified in the query request. Default and maximum page sizes are specified in the vCloud Director
configuration. You can also apply filter criteria to the list of items returned.
This chapter includes the following topics:
n
“Typed Queries,” on page 201
n
“Packaged Queries,” on page 207
n
“Query Parameters,” on page 211
Typed Queries
Typed queries require you to construct a query URL that specifies an object type and optional parameters.
Query Syntax
Typed queries have the following syntax:
API-URL
/query?type=
name
[&
param
][&
param
... ][&
filter
]
n
API-URL is a URL of the form https://vcloud.example.com/api.
n
name is the name of a query type. Type names are case-sensitive.
VMware, Inc.
201