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
vCloud API Object Metadata Limits
The following limits apply to vCloud API object metadata:
Metadata key size
The contents of a Key element in a MetadataEntry cannot exceed 256 Unicode
characters.
Metadata size
The size of all Metadata for an object, computed as the sum of all Key and
Value UTF-8 strings, cannot exceed 128 KB.
MetadataEntry limit
The total metadata associated with an object cannot exceed 1024 pairs, where
a pair consists of a Key and corresponding Value.
This chapter includes the following topics:
n
“Retrieve or Update a Metadata Element,” on page 196
n
“Retrieve or Update a Metadata Value,” on page 199
Retrieve or Update a Metadata Element
A system administrator or the owner of an object can create, retrieve, or update the object's Metadata element.
This element contains all object metadata, and operations that modify it merge the modifications with existing
contents.
When you create an object, its representation is populated with an empty Metadata element. A system
administrator or the object owner can add metadata by updating the Metadata element with new
MetadataEntry elements. Each of these elements contains a Key and a Value. The contents of the Key element
define the key name, which must be unique within the scope of the object's metadata. You can modify the
value associated with an existing key. See “Retrieve or Update a Metadata Value,” on page 199.
NOTE The Key element cannot contain a semicolon character (;). In addition, several other character sequences
are not allowed, or not allowed in certain positions.
Table 8-1. Content Restrictions for Key
Cannot Contain Cannot Start with Cannot End with
/../ ./ /.
/./ ../ /..
Prerequisites
Verify that you are logged in as a system administrator or the object owner.
Procedure
1 Retrieve the representation of the object.
Examine the response to find its metadata link. This example shows the metadata link from an Org.
<Link
rel="down"
type="application/vnd.vmware.vcloud.metadata+xml"
href="https://vcloud.example.com/api/org/26/metadata"/>
vCloud API Programming Guide
196 VMware, Inc.