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
Table 1-3. HTTP Status Codes that the vCloud API Returns
Status Code Status Description
200 OK The request is valid and was completed. The response
includes a document body.
201 Created The request is valid. The requested object was created and
can be found at the URL specified in the Location header.
202 Accepted The request is valid and a task was created to handle it. This
response is usually accompanied by a Task element.
204 No Content The request is valid and was completed. The response does
not include a body.
303 See Other The response to the request can be found at the URL specified
in the Location header.
400 Bad Request The request body is malformed, incomplete, or otherwise
invalid.
401 Unauthorized An authorization header was expected but not found.
403 Forbidden The requesting user does not have adequate privileges to
access one or more objects specified in the request.
404 Not Found One or more objects specified in the request could not be
found in the specified container.
405 Method Not Allowed The HTTP method specified in the request is not supported
for this object.
500 Internal Server Error The request was received but could not be completed
because of an internal error at the server.
501 Not Implemented The server does not implement the request.
503 Service Unavailable One or more services needed to complete the request are not
available on the server.
Using the vCloud API with vCloud Director
VMware vCloud Director 1.5 supports version 1.5 of the vCloud API. You can use a browser or other HTTP
client program to send requests and receive responses.
The vCloud Director REST API Reference documentation includes HTML reference material for all XML
elements and complex types defined by the vCloud API. It also includes examples XML representations. See
“About the Schema Reference Downloadable Archive,” on page 19. For information about HTTP client
programs to use with vCloud Director, see “REST Client Programs,” on page 19.
Procedure
1 Configure the vCloud Director REST API base URL.
a Log in to the vCloud Director Web Console as a system administrator.
b In the vCloud Director Web Console, open System Settings > Public Addresses
c Type the URL in the VCD public REST API base URL text box.
2 Download the schema reference.
The schema reference is an essential supplement to the vCloud API Programming Guide.
What to do next
Decide on an HTTP client program to use. See “REST Client Programs,” on page 19.
vCloud API Programming Guide
18 VMware, Inc.