5.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
- Summary of vCloud API Browsing Requests
- Retrieve the Login URL and List of Supported API Versions
- Create a Login Session Using the Integrated Identity Provider
- Retrieve a List of Organizations Accessible to You
- Retrieve an Administrative View of a Cloud
- Retrieve a List of vSphere Platform Operations and Objects for a Cloud
- Provisioning an Organization
- Summary of vCloud API Provisioning Requests
- Upload an OVF Package to Create a vApp Template
- Download a vApp or vApp Template as OVF
- Upload a Media Image
- Download a Media Image
- Capturing and Importing vApps
- Managing Catalog Items
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- Controlling Access to vApps and Catalogs
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Create a vApp From an OVF Package
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Clone a vApp
- Capture a vApp as a Template
- Update vApp Access Controls
- Provide User Input Requested by a Virtual Machine
- Attach or Detach an Independent Disk
- Creating and Using vApp Snapshots
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Update Multiple Sections of 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
- Update the Storage Profile for a Virtual Machine
- Creating and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- VDC Administration
- Network Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Managing and Monitoring a Cloud
- Summary of System Administration Requests
- Retrieve or Update System Settings
- Attach a vCenter Server
- Finding Available vCenter Resources
- Create a Provider VDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- Relocate a Virtual Machine to a Different Datastore
- Truststore and Keytab Maintenance
- Retrieve the vSphere URL of an Object
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- vCloud Director Extension Services
- XML Representations in the vCloud API
- Index
description=""
createdOn="2011-03-21T14:28:09.273-07:00"
href="https://vcloud.example.com/api/catalog/150" />
</QueryResultRecords>
Query Parameters
Query parameters specify result set properties such as pagination, sort order, and filter criteria.
Query Parameters
Typed queries must include a type parameter, which specifies the type of query to run. Packaged queries
cannot specify a type parameter. All other parameters are optional. If a parameter is omitted, a default value
is assumed.
Table 9‑2. Query Parameters
Parameter Name Parameter Description Default
type
The type of the query. Type names are case-sensitive. See
“Query Types,” on page 290.
None. This parameter is
required for all typed
queries, and is not allowed
for any packaged query.
sortAsc=attribute-name
Sort results by attribute-name in ascending order. attribute-
name cannot include metadata. See the vCloud API Schema
Reference for infomation about which attributes can be used
with sortDesc.
Sorted by database ID
sortDesc=attribute-name
Sort results by attribute-name in descending order. attribute-
name cannot include metadata. See the vCloud API Schema
Reference for infomation about which attributes can be used
with sortDesc.
Sorted by database ID
page
If the query results span multiple pages, return this page.
page=1
pageSize
Number of results per page, to a maximum of 128.
pageSize=25
format
One of the following types:
references
Returns a reference to each object,
including its name, type, and href
attributes.
records
Returns all database records for each
object, with each record as an attribute.
idrecords Identical to the records format, except
that object references are returned in id
format rather than href format.
format=records
fields
Comma-separated list of attribute names or metadata key
names to return. For example, fields=name,isEnabled or
fields=metadata:rank. See “Specifying Metadata in a
Query or a Filter Expression,” on page 300.
Returns all static attribute
names. Returns metadata
only if the object has a non-
empty Metadata element.
offset
Integer value specifying the first record to return. Record
numbers < offset are not returned.
offset=0
filterEncoded
Specify whether the filter expression is encoded as described
in RFC3986 (pct-encoded). See “Encoding Filter
Expressions,” on page 302
filterEncoded=false
filter
Filter expression. See Table 9-3 None
Chapter 9 Using the Query Service
VMware, Inc. 299