VMware VCLOUD API 1.0 - API User Manual

vCloud API Programming Guide
146 VMware, Inc.
XML Namespace Prefixes in Request and Response Bodies
WhenarequestorresponseincludeselementsfrommultipleXMLnamespaces,eachelementnameisprefixed
withanamespaceidentifier.UnlessallelementsinarequestorresponseoriginateinthesameXML
namespace,theseprefixesarerequiredinrequestbodies,andarealwaysincludedinresponsebodies.
Example 5‐16on
page 78andExample 7‐22onpage 133showhownamespaceprefixesappearinelement
names.
Common Elements
ThevCloud APIdefinesanumberofelementsthatcanbecontainedbytherepresentationsofmanykindsof
objects.
Description
TheDescriptionelementcontainsastringthatdescribestheobject.Thiselementisalwaysoptional.
Error
Errorelementsareusedtotransmitread‐onlyerrorinformationinaresponse.
Content-Type application/vnd.vmware.vcloud.error+xml
Table 8‐6liststheminorerrorcodevaluesdefinedinthisreleaseofthevCloud API.
Schema
Name Min Max Type Description
message 1 1 xs:string Messagedescribingtheerror
majorErrorCode 1 1 xs:int MatchestheHTTPstatuscode.See“StatusCodes”onpage 18.
minorErrorCode 1 1 xs:string Errorcodespecifictothefailedoperation
vendorSpecificErrorCode 0 1 xs:string Emptyinthisrelease
stackTrace 0 1 xs:string Stacktraceoftheerror,ifavailable.Thisattributeisreturned
onlytoasystemadministrator.
Table 8-6. Minor Error Codes
Error Code Description of Error
ACCESS_TO_RESOURCE_IS_FORBIDDEN Therequestwasmadebyauserwhohadinsufficientrightstotheobject
oroperation.
BAD_REQUEST TherequestcouldnotbevalidatedorcontainedinvalidXML.
CONFLICT AconflictwasdetectedbetweensectionsofanOVFdescriptor.
EULA_NOT_ACCEPTED AnattempttoinstantiateavAppTemplateoruseavAppTemplateora
Vmin
acompositiondidnotincludeanAllEULAsAcceptedelement
withavalueoftrue.
INTERNAL_SERVER_ERROR Returnedforanyfailurethatcannotbematchedtoanotherminorerror
code.
INVALID_REFERENCE Oneormorereferences(hrefattributevalues)suppliedintherequest
couldnotberesolvedtoanobject.
METHOD_NOT_ALLOWED TheHTTPmethod(GET,PUT,
POST,DELETE)isnotallowedforthe
request.
RESOURCE_NOT_FOUND Oneormorereferences(hrefattributevalues)suppliedintherequest
couldnotberesolvedtoanobject,ortheContent‐typeoftherequest
wasincorrect.

VMware VCLOUD API 1.0 - API Specifications

General

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