Table of Contents
Advertisement
3
Browsing
A vCloud API client can use HTTP GET requests to browse containers such as organizations, catalogs, and
vDCs. Responses to these requests include metadata about the container itself and references to the objects it
contains. These references are provided in Link elements, which have href attributes whose values the client
can use in requests to get more information about the objects themselves. This hierarchical structure of
containers lends itself to graphical representation as a folder hierarchy or tree view of vCloud objects, and
enables clients to use the same set of objects and operations to implement a breadth‐first or depth‐first
approach to browsing.
This chapter includes the following topics:
"Summary of Browsing Requests" on page 33
"Discovering the Contents of an Organization, Catalog, or vDC" on page 34
"Getting More Information About an Object" on page 38
Summary of Browsing Requests
Table
3‐1 summarizes browsing requests supported in this release. The table uses the following conventions:
API‐URL is a URL of the form http://vcloud.example.com/api/v1.0
id is an integer
Table 3-1. Summary of Browsing Requests
Operation
Show Login URL and List Supported
API Versions
Log in
Log out
List the Organizations in a vCloud
List the Contents of an Organization
Get Information About a Network
List the Contents of a Catalog
Get Information About a CatalogItem
List the Contents of a vDC
Get Information About a Media Image
Get Information About a
vAppTemplate
Get Information About a vApp or
Virtual Machine
VMware, Inc.
Request
GET http://hostname/api/versions
POST API‐URL/login
POST API‐URL/logout
GET API‐URL/org
GET API‐URL/org/id
GET API‐URL/network/id
GET API‐URL/catalog/id
GET API‐URL/catalogItem/id
GET API‐URL/vdc/id
GET API‐URL/media/id
GET API‐URL/vAppTemplate/vappTemplate‐id
GET API‐URL/vApp/vapp‐id
Request Body
Response
None
SupportedVersions
None
OrgList
None
200 OK
None
OrgList
None
Org
None
OrgNetwork
None
Catalog
None
CatalogItem
None
Vdc
None
Media
None
VAppTemplate
None
VApp
3
33
Advertisement
Table of Contents
