Vcloud Api Specification Vmware

1686138829
ADVERTISEMENT
Vcloud api specification vmware

File Name: vcd_15_api_spec.pdf

File Size: 362.26 KB

File Type: Application/pdf

Last Modified: 11 years

Status: Available

Last checked: 7 days ago!

This Document Has Been Certified by a Professional

100% customizable

Language: English

We recommend downloading this file onto your computer

Summary

vCloud API Specification
vCloud Director 1.5
This document supports the version of each product listed and
supports all subsequent versions until the document is replaced
by a new edition. To check for more recent editions of this
document, see http://www.vmware.com/support/pubs

EN-000584-00
vCloud API Specification
You can find the most up-to-date technical documentation on the VMware Web site at:
http://www.vmware.com/support/
The VMware Web site also provides the latest product updates

If you have comments about this documentation, submit your feedback to:
[email protected]
Copyright © 2009–2011 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and
intellectual property laws. VMware products are covered by one or more patents listed at
http://www.vmware.com/go/patents

VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks
and names mentioned herein may be trademarks of their respective companies

VMware, Inc

3401 Hillview Ave

Palo Alto, CA 94304
www.vmware.com
2 VMware, Inc

Contents
vCloud API Specification 5
vCloud API Specification 7
Summary of vCloud API Browsing Requests 7
Summary of vCloud API Provisioning Requests 8
Summary of vCloud API vApp and Virtual Machine Operations Requests 9
Summary of vApp Reconfiguration Requests 11
Summary of Vm Reconfiguration Requests 11
Index 15
VMware, Inc. 3
vCloud API Specification
4 VMware, Inc

vCloud API Specification
The vCloud API Specification summarizes the user operations supported by version 1. 5 of the vCloud API

VMware provides many different APIs and SDKs for various applications and goals. This specification
provides information about the vCloud API for developers that are interested in creating RESTful clients of
VMware vCloud Director

Revision History
The vCloud API Specification is revised with each release of the product or when necessary. A revised version
can contain minor or major changes

Table 1. Revision History
Revision Date Description
01SEP11 API Version 1.5
30AUG10 API Version 1.0
14APR10 API Version 0.9
Intended Audience
This guide is intended for software developers who are building VMware Ready Cloud Services, including
interactive clients of VMware vCloud Director. This guide assumes you are familiar with Representational
State Transfer (REST) and RESTful programming conventions, the Open Virtualization Format Specification,
and VMware Virtual machine technology. Familiarity with other widely-deployed technologies such as XML,
HTTP, and the Windows or Linux operating systems is also assumed

Related Publications
The VMware vCloud Director Administrator's Guide and VMware vCloud Director User’s Guide contain detailed
information about many of the objects and operations referred to in this guide. Most users of the vCloud API
will find the information in those documents valuable when developing client applications. To access the
current versions of these and other VMware books, go to http://www.vmware.com/support/pubs

VMware, Inc. 5
vCloud API Specification
6 VMware, Inc

vCloud API Specification
This specification summarizes the user operations supported by version 1. 5 of the vCloud API

Terms and Conditions
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the “Software”), to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of
the Software

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

Except as explicitly provided herein, no express or implied licenses, under any VMware patents, copyrights,
trademarks, or any other intellectual property rights, are granted or waived by implication, exhaustion,
estoppel, or otherwise, on modified versions of the Software

Summary of vCloud API Browsing Requests
Browsing requests provide read-only access to a cloud and the objects it contains

n API-URL is a URL of the form https://vcloud.example.com/api

n id is a unique identifier

Request URLs are always available when you GET the representation of the object on which they operate. URL
forms are for reference purposes only

Table 2. Summary of vCloud API Browsing Requests
Operation Request Request Body Response
Show login URL and list of GET API-URL/versions None SupportedVersions
supported API versions
Log in [NEW] POST API-URL/sessions None Session
Log out [NEW] DELETE API-URL/session None 200 OK
Log in [DEPRECATED] POST API-URL/login None OrgLIst
Log out [DEPRECATED] POST API-URL/login None 200 OK
VMware, Inc. 7
vCloud API Specification
Table 2. Summary of vCloud API Browsing Requests (Continued)
Operation Request Request Body Response
Retrieve a list of entry points GET API-URL/session None 200 OK
for browsing operations
[NEW]
Retrieve a list of GET API-URL/org/ None OrgList
organizations to which you
have access
Retrieve the contents of an GET API-URL/org/id None Org
organization
Retrieve properties of a GET API-URL/network/id None OrgNetwork
network
Retrieve the contents of a GET API-URL/catalog/id None Catalog
catalog
Retrieve properties of a GET API- None CatalogItem
catalog item URL/catalogItem/id
Retrieve the contents of a GET API-URL/vdc/id None Vdc
vDC
Retrieve properties of a GET API-URL/media/id None Media
media image
Retrieve a vApp template GET API- None VAppTemplate
URL/vAppTemplate/vappT
emplate-id
Retrieve properties of a vApp GET API-URL/vApp/vapp- None VApp
id
Retrieve properties of a GET API-URL/vApp/vm-id None Vm
virtual machine
Summary of vCloud API Provisioning Requests
Provisioning requests add vApp templates and media to a vDC and a catalog. You can also use provisioning
requests to copy, move, rename, and delete these objects

n API-URL is a URL of the form https://vcloud.example.com/api

n id is a unique identifier

Request URLs are always available when you GET the representation of the object on which they operate. URL
forms are for reference purposes only

Table 3. Summary of Provisioning Requests
Operation Request Request Body Response
Upload OVF to create a vApp POST API-URL/vdc/id/ UploadVAppTemplatePara VAppTemplate
template. action/uploadVAppTempla ms
te
Download a vApp template GET download-URL None Depends on file type
as OVF

Enable a vApp template for POST API- None Task
download. URL/vAppTemplate/
vAppTemplate-
id/action/enableDownload
8 VMware, Inc

vCloud API Specification
Table 3. Summary of Provisioning Requests (Continued)
Operation Request Request Body Response
Disable a vApp template for POST API- None 204 No Content
download. URL/vAppTemplate/
vAppTemplate-
id/action/disableDownload
Upload a media image. POST API- Media Media
URL/vdc/id/media
Copy or move a media image. POST API- CloneMediaParams Media
URL/vdc/
id/action/cloneMedia
Copy or move a vApp POST API- CloneVAppTemplateParam VAppTemplate
template. URL/vdc/id/action/ s
cloneVAppTemplate
Copy or move a vApp. POST API- CloneVAppParams VApp
URL/vdc/
id/action/cloneVApp
Change the name or PUT API- VAppTemplate Task
description of a vApp URL/vAppTemplate/vappT
template. emplate-id
Change the name or PUT API-URL/vApp/vapp- VApp Task
description of a vApp. id
Change the name or PUT API-URL/media/id Media Task
description of a media image

Delete a vApp template, DELETE object-URL None Task
vApp, or media image

Add an item to a catalog. POST API- CatalogItem CatalogItem
URL/catalog/
id/catalogItems
Remove an item from a DELETE API-URL/ None 204 No content
catalog. catalog/id/catalogItem/id
Control access to catalogs. POST API- ControlAccessParams ControlAccessParams
URL/catalog/
id/action/controlAccess
Retrieve the owner of a media GET API- None Owner
object. [NEW] URL/media/id/owner
Retrieve the owner of a vApp GET API- None Owner
template [NEW] URL/vAppTemplate/vappT
emplate-id/owner
Retrieve the owner of a vApp GET API- None Owner
[NEW] URL/vApp/id/owner
Update the owner of a vApp PUT API- Owner 204 No Content
[NEW] URL/vApp/id/owner
Update the owner of a catalog PUT API- Owner 204 No Content
[NEW] URL/vApp/id/owner
Summary of vCloud API vApp and Virtual Machine Operations Requests
These vCloud API operations requests create, manage, operate, and delete vApps and the virtual machines
that they contain

n API-URL is a URL of the form https://vcloud.example.com/api

VMware, Inc. 9
vCloud API Specification
n id is a unique identifier

n VApp-or-Vm-URL is a URL of the form API-URL/vApp/vapp-id (for a VApp object) or API-URL/vApp/vm-
id (for a Vm object)
n Vm-URL is a URL of the form API-URL/vApp/vm-id
Request URLs are always available when you GET the representation of the object on which they operate. URL
forms shown in the table are for reference purposes only

Table 4. Summary of vCloud API Operations Requests
Operation Request Request Body Response
Instantiate a vApp template POST API-URL/vdc/id/ InstantiateVAppTemplat VApp
action/instantiateVAppTe eParams
mplate
Compose a vApp POST API-URL/vdc/id/ ComposeVAppParams VApp
action/composeVApp
Recompose a vApp to add or POST API- RecomposeVAppParams Task
remove virtual machines URL/vApp/vapp-id/
action/recomposeVApp
Deploy a vApp or Virtual POST VApp-or-Vm- DeployVAppParams Task
Machine URL/action/deploy
Undeploy a vApp or Virtual POST VApp-or-Vm- UndeployVAppParams Task
Machine URL/action/undeploy
Power On a vApp or Virtual POST VApp-or-Vm- None Task
Machine URL/action/powerOn
Power Off a vApp or Virtual POST VApp-or-Vm- None Task
Machine URL/action/powerOff
Reset a vApp or Virtual POST VApp-or-Vm- None Task
Machine URL/action/reset
Suspend a vApp or Virtual POST VApp-or-Vm- None Task
Machine URL/action/suspend
Discard the Suspended State POST VApp-or-Vm- None Task
of a vApp or Virtual Machine URL/action/
discardSuspendedState
Shut Down a vApp or Virtual POST VApp-or-Vm- None Task
Machine URL/action/shutdown
Reboot a vApp or Virtual POST VApp-or-Vm- None Task
Machine URL/action/reboot
Retrieve product sections of a GET VApp-or-Vm- None ProductSectionList
vApp or virtual machine URL/productSections
[NEW]
Update product sections of a PUT VApp-or-Vm- ProductSectionList Task
vApp or virtual machine URL/productSections
[NEW]
Retrieve product sections of a GET API- None ProductSectionList
vApp template [NEW] URL/vAppTemplate/vappT
emplate-id/productSections
Update product sections of a PUT API- ProductSectionList Task
vApp template [NEW] URL/vAppTemplate/vappT
emplate-id/productSections
Insert Media Into a Virtual POST Vm- MediaInsertOrEjectPara Task
Machine URL/action/insertMedia ms
10 VMware, Inc

vCloud API Specification
Table 4. Summary of vCloud API Operations Requests (Continued)
Operation Request Request Body Response
Eject Media from a Virtual POST Vm- MediaInsertOrEjectPara Task
Machine URL/action/ejecttMedia ms
List Media Devices of a GET Vm-URL/ None RasdItemsList
Virtual Machine virtualHardwareSection/m
edia
Get a Request for User Input GET Vm-URL/question None VmPendingQuestion
Provide Requested User POST Vm- VmQuestionAnswer 204 No Content
Input URL/question/action/answ
er
Get a Screen Thumbnail for a GET Vm-URL/screen None Returns a screen thumbnail
Virtual Machine (Content-type: image/png) if
one is available. Otherwise
returns null (Content-Length:
0)

Get a Screen Ticket for a POST Vm-URL/ None ScreenTicket
Virtual Machine screen/action/acquireTicket
Summary of vApp Reconfiguration Requests
vApp reconfiguration requests retrieve or update modifiable sections of a vApp

n API-URL is a URL of the form https://vcloud.example.com/api

n id is a unique identifier

Request URLs are always available when you GET the representation of the object on which they operate. URL
forms are for reference purposes only

Table 5. Summary of vApp Reconfiguration Requests
Operation Request Request Body Response
Retrieve vApp GET API-URL/vApp/vapp- None LeaseSettingsSection
LeaseSettingsSection id/ leaseSettingsSection/
Update vApp PUT API-URL/vApp/vapp- LeaseSettingsSection Task
LeaseSettingsSection id/ leaseSettingsSection/
Retrieve vApp GET API-URL/vApp/vapp- None StartupSection
StartupSection id/ startupSection/
Update vApp PUT API-URL/vApp/vapp- StartupSection Task
StartupSection id/ startupSection/
Retrieve vApp GET API-URL/vApp/vapp- None NetworkConfigSection
NetworkConfigSection id/ networkConfigSection/
Update vApp PUT API-URL/vApp/vapp- NetworkConfigSection Task
NetworkConfigSection id/ networkConfigSection/
Summary of Vm Reconfiguration Requests
Vm reconfiguration requests retrieve or update modifiable sections of a virtual machine (Vm object)
n API-URL is a URL of the form https://vcloud.example.com/api

n id is a unique identifier

Request URLs are always available when you GET the representation of the object on which they operate. URL
forms are for reference purposes only

VMware, Inc. 11
vCloud API Specification
Table 6. Summary of Vm Reconfiguration Requests
Operation Request Request Body Response
Retrieve the GET API-URL/vApp/vm-id/ None NetworkConnectionSectio
NetworkConnectionSectio networkConnectionSectio n
n of a virtual machine n/
Update the PUT API-URL/vApp/vm-id/ NetworkConnectionSecti Task
NetworkConnectionSectio networkConnectionSectio on
n of a virtual machine n/
Retrieve the GET API-URL/vApp/vm-id/ None GuestCustomizationSecti
GuestCustomizationSecti guestCustomizationSectio o
on of a virtual machine n/
Update the PUT API-URL/vApp/vm-id/ GuestCustomizationSect Task
GuestCustomizationSecti guestCustomizationSectio io
on of a virtual machine n/
Retrieve the GET API-URL/vApp/vm-id/ None OperatingSystemSection
OperatingSystemSection operatingSystemSection/
of a virtual machine
Update the PUT API-URL/vApp/vm-id/ OperatingSystemSection Task
OperatingSystemSection operatingSystemSection/
of a virtual machine
Retrieve the GET API-URL/vApp/vm-id/ None VirtualHardwareSection
VirtualHardwareSection virtualHardwareSection/
of a virtual machine
Update the PUT API-URL/vApp/vm-id/ VirtualHardwareSection Task
VirtualHardwareSection virtualHardwareSection/
of a virtual machine
Retrieve the CPU GET API-URL/vApp/vm-id/ None ovf:Item
configuration of a virtual virtualHardwareSection/
machine cpu
Update the CPU PUT API-URL/vApp/vm-id/ ovf:Item Task
configuration of a virtual virtualHardwareSection/
machine cpu
Retrieve the memory item GET API-URL/vApp/vm-id/ None ovf:Item
from the virtualHardwareSection/
VirtualHardwareSection memory
of a virtual machine
Update the memory item in PUT API-URL/vApp/vm-id/ ovf:Item Task
the virtualHardwareSection/
VirtualHardwareSection memory
of a virtual machine
Retrieve virtual disk items GET API-URL/vApp/vm-id/ None RasdItemsList
from the virtualHardwareSection/
VirtualHardwareSection disks
of a virtual machine
Update virtual disk items in PUT API-URL/vApp/vm-id/ RasdItemsList Task
the virtualHardwareSection/
VirtualHardwareSection disks
of a virtual machine
12 VMware, Inc

VCloud API Specification The vCloud API Specification summarizes the user operations supported by version 1. 5 of the vCloud API. VMware provides many different APIs and SDKs for various …

Download Now

Documemt Updated

ADVERTISEMENT

Popular Download

ADVERTISEMENT

Frequently Asked Questions

What is the vcloud api schema reference?

providerVdcResourcePoolRe.. The vCloud API Schema Reference includes reference material for all elements, types, operations, and queries in the vCloud API. It also includes the schema definition files and a summary of changes to the schemas in this release.

What happened to the vcloud api query type?

The first vCloud API release in which this query type was marked as deprecated. You can download an archive of XML schema definition files (*.xsd) for the vCloud API. The archive includes two folders: Schema definition files for vCloud API version 1.5 and later.

Can a client modify the contents of a vcloud element?

A client cannot modify the contents. The vCloud API version in which this element first appeared. If use of this element is deprecated, the vCloud API version in which deprecation was announced. A description of the purpose and contents of the element.