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
organizationName="Engineering"
numberOfTemplates="8"
numberOfMedia="1"
name="catalog1"
isShared="true"
isPublished="true"
description=""
createdOn="2011-03-22T16:14:06.360-07:00"
href="https://vcloud.example.com/api/catalog/91" />
</QueryResultRecords>
Packaged query using references format.
GET https://vcloud.example.com/api/catalogs/query?format=references
Response:
<CatalogReferences
xmlns="http://www.vmware.com/vcloud/v1.5"
total="15"
pageSize="25"
page="1"
name="catalog"
type="application/vnd.vmware.vcloud.query.references+xml"
href="https://vcloud.example.com/api/catalogs/query?
page=1&pageSize=25&format=references"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ... >
<Link
rel="alternate"
type="application/vnd.vmware.vcloud.query.records+xml"
href="https://vcloud.example.com/api/catalogs/query?
type=catalog&page=1&pageSize=25&format=records" />
<CatalogReference
type="application/vnd.vmware.vcloud.catalog+xml"
name="VAM"
href="https://vcloud.example.com/api/catalog/150" />
<CatalogReference
type="application/vnd.vmware.vcloud.catalog+xml"
name="QA-Cat"
href="https://vcloud.example.com/api/catalog/78" />
<CatalogReference
type="application/vnd.vmware.vcloud.catalog+xml"
name="Catalog-3f79780c-6b0"
href="https://vcloud.example.com/api/catalog/99" />
<CatalogReference
type="application/vnd.vmware.vcloud.catalog+xml"
name="TestCat"
href="https://vcloud.example.com/api/catalog/43" />
<CatalogReference
type="application/vnd.vmware.vcloud.catalog+xml"
name="catalog1"
href="https://vcloud.example.com/api/catalog/91" />
</CatalogReferences>
Chapter 9 Using the Query Service
VMware, Inc. 297