Common Elements; Description; Error - VMware VCLOUD API 1.0 - API Programming Manual

Table of Contents

Advertisement

vCloud API Programming Guide
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
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
Schema
Name
message
majorErrorCode
minorErrorCode
vendorSpecificErrorCode
stackTrace
Table
8‐6 lists the minor error code values defined in this release of the vCloud API.
Table 8-6. Minor Error Codes
Error Code
ACCESS_TO_RESOURCE_IS_FORBIDDEN 
BAD_REQUEST
CONFLICT
EULA_NOT_ACCEPTED
INTERNAL_SERVER_ERROR
INVALID_REFERENCE 
METHOD_NOT_ALLOWED 
RESOURCE_NOT_FOUND
146
133 show how namespace prefixes appear in element 
Min
Max
Type
Description
1
1
xs:string
Message describing the error
1
1
xs:int
Matches the HTTP status code. See "Status Codes" on page 18.
1
1
xs:string
Error code specific to the failed operation
0
1
xs:string
Empty in this release
0
1
xs:string
Stack trace of the error, if available. This attribute is returned 
only to a system administrator.
Description of Error
The request was made by a user who had insufficient rights to the object 
or operation.
The request could not be validated or contained invalid XML.
A conflict was detected between sections of an OVF descriptor.
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.
Returned for any failure that cannot be matched to another minor error 
code.
One or more references (href attribute values) supplied in the request 
could not be resolved to an object.
The HTTP method (GET, PUT, POST, DELETE) is not allowed for the 
request.
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, Inc.

Advertisement

Table of Contents
loading

Table of Contents