VMware VCLOUD API 1.0 - API User Manual

VMware, Inc. 33
3
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
Browsing
3
Table 3-1. Summary of Browsing Requests
Operation Request Request Body Response
ShowLoginURLandListSupported
APIVersions
GEThttp://hostname/api/versions None SupportedVersions
Login POSTAPI‐URL/login None OrgList
Logout POSTAPI‐URL/logout None 200OK
ListtheOrganizationsinavCloud GETAPI‐URL/org None OrgList
ListtheContentsofanOrganization GETAPI‐URL/org/id None Org
GetInformationAboutaNetwork GETAPI‐URL/network/id None OrgNetwork
Listthe
ContentsofaCatalog GETAPI‐URL/catalog/id None Catalog
GetInformationAboutaCatalogItem GETAPI‐URL/catalogItem/id None CatalogItem
ListtheContentsofavDC GETAPI‐URL/vdc/id None Vdc
GetInformationAboutaMediaImage GETAPI‐URL/media/id None Media
GetInformationAbouta
vAppTemplate
GETAPI‐URL/vAppTemplate/vappTemplate‐id None VAppTemplate
GetInformationAbouta
vAppor
VirtualMachine
GETAPI‐URL/vApp/vapp‐id None VApp

VMware VCLOUD API 1.0 - API Specifications

General

Brand	VMware
Model	VCLOUD API 1.0 - API
Category	Software
Language	English