5.1
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 Template as OVF
- Upload a Media Image
- Copying and Moving with the vCloud API
- Capturing and Importing vApps
- Cataloging vApp Templates and Media Images
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- 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
- 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
- Controlling Access to vApps and Catalogs
- Managing and Monitoring a Cloud
- Summary of vSphere Platform Extension 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
Table 11-1. Summary of vCloud API Extensibility Requests (Continued)
Operation Request Request Body Response
Create API definitions for a
registered extension service.
POST API-
URL/admin/extension/serv
ice/id/definitions
ApiDefinition ApiDefinition
Create file descriptors for a
registered extension service.
POSTAPI-
URL/admin/extension/serv
ice/definition/id/files
FileDescriptor FileDescriptor
Register an Extension Service
Register an extension service to specify its namespace, AMQP exchange and routing key, and URL patterns.
You can specify additional service properties during registration or update them later.
An extension service typically authenticates with the vCloud API as a system administrator, then registers
itself by POSTing a Service element to the system's .../api/admin/extension/service URL. A Service element
must include the following elements.
Namespace
The service namespace, which must be unique among all registered extension
services. Service namespace names that follow the naming convention used for
Java packages (for example, com.example.service.backup) are more likely to
be unique. If a service tries to register a namespace that is already registered,
registration fails.
RoutingKey
The AMQP routing key that vCloud Director must use when routing messages
to the service.
Exchange
The AMQP exchange name that vCloud Director must use when routing
messages to the service. The service must create the specified exchange on the
AMQP service that vCloud Director uses. The exchange type must be direct.
ApiFilters
Specifies one or more URL patterns that the vCloud Director REST service must
treat as extension requests. URL patterns can include regular expressions that
java.util.regex.Pattern recognizes. See “Create an API Filter for an
Extension Service,” on page 302.
Registration can also specify the following optional properties:
n
Definitions of Link elements that the service adds to the representations of vCloud API objects. See
“Adding or Removing Service Links,” on page 288
n
Authorization framework for controlling access to the service's objects and operations. See “Authorization
Framework for Extension Service Operations,” on page 294.
n
Locations of schema files if the service provides its own API. See “REST APIs for Extension Services,” on
page 302
You can also create or update these properties after you register the service.
Prerequisites
Verify that you are logged in to the vCloud API as a system administrator.
Procedure
1 Retrieve the XML representation of the cloud.
Use a request like this one:
GET https://vcloud.example.com/api/admin/extension
vCloud API Programming Guide
284 VMware, Inc.