Getting More Information About An Object; Get Information About A Media Image - VMware VCLOUD API 1.0 - API Programming Manual

vCloud API Programming Guide
<ResourceEntity href="http://vcloud.example.com/vApp/vapp-413"
...
</ResourceEntities>
<AvailableNetworks>
<Network href="http://vcloud.example.com/api/v1.0/network/14"
<Network href="http://vcloud.example.com/api/v1.0/network/54"
</AvailableNetworks>
<NicQuota>0</NicQuota>
<NetworkQuota>0</NetworkQuota>
<VmQuota>0</VmQuota>
<IsEnabled>true</IsEnabled>
</Vdc>
The response is a detailed description of the vDC and its contents. It includes:

Link elements whose rel attribute has a value of add. Each of these links has an href attribute whose
value is a URL that a client can use to add vApps, vApp templates, and media images to vDC inventory.
Several methods of adding inventory are supported, including upload, clone, and compose.

ResourceEntity elements that reference vApps that have been instatiated in or imported to this vDC,
and vApp templates and virtual media images that have been uploaded to the vDC.

A list of organization networks that are available in the vDC.

Other metadata, including quota and vDC state information.
For more information, see "Vdc" on page 152.

Getting More Information About an Object

An object in a vCloud can be represented by links in various types of XML containers. Regardless of where the
link appears, the object reference it contains (its href attribute value) is always the same. An organization
network can be represented by a link with rel="down" in an organization, or as a member of the
AvailableNetworks element of a vDC.
Catalogs provide a level of indirection for references to media images and vApp templates. A vApp template
or media image can be referenced by a CatalogItem in a catalog or a ResourceEntity in a vDC. The
CatalogItem shown in Example
http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate‐111, is also contained by the vDC
referenced in Example
which includes a link (the value of the href attribute) to the template. The Catalog, on the other hand,
contains only CatalogItem elements, each of which includes a link that a client can use to get more
information about the object that the CatalogItem represents. Both the ResourceEntity in the Vdc and the
CatalogItem in the Catalog refer to the same vApp template. The ResourceEntity element includes a link
that a client can use to GET a representation of the vApp, but a client must first GET a CatalogItem to obtain
that kind of link, which is not contained in the Catalog itself.
A ResourceEntity element appears in a Vdc element as soon as the underlying vApp template or media
image has been created. References to those objects do not appear in a catalog until the catalog owner adds
them to it. In most cases, the objects cannot be used until they have been added to a catalog.

Get Information About a Media Image

A client can discover the URL of a media image by browsing in a catalog and examining a CatalogItem to
find the Entity element that references the image, or by browsing in a vDC for a ResourceEntity element
that references the image. After client has the image's URL, it can use it as the target of a GET request, as shown
in Example 3‐5.
If the media image has been included in a catalog, the Media element in the response includes a link to the
CatalogItem that references it.
38
type="application/vnd.vmware.vcloud.vApp+xml" name="Example Corp. CRM"/>
type="application/vnd.vmware.vcloud.network+xml" name="IsolatedOrgNet"/>
type="application/vnd.vmware.vcloud.network+xml" name="Internet"/>
3‐2, a VAppTemplate whose URL is
3‐4. In the Vdc body, the VAppTemplate is represented as ResourceEntity element,
VMware, Inc.