1.0.1

VMware, Inc. 9
Chapter 1 vCenter Chargeback APIs
IfanAPItaskisunsuccessful,thestatusfieldissettofailureandtheErrorelementcapturesallthedetails
asexplainedinthetableprovidedafterthiscodesample.
<?xml version="1.0" encoding="UTF-8"?>
<Response status="failure" isValidLicense="true"
xmlns="http://www.vmware.com/vcenter/chargeback/1.0.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Error majorErrorCode="500" minorErrorCode="2014"
message="Hierarchy with id '1' does not exist." />
</Response>

Common Elements in the Request and Response XMLs
ThecommonXMLelementsusedbytherequestandresponseXMLsarepresentedinthefollowingtable.
RefertotheearliersectionsforsamplerequestandresponseXMLs.
Chargeback API Syntax
EachvCenterChargebackAPIhasthissyntax:
<HTTP_request_method> <Base_Url>/<API_signature>?version=1.0.1
Forexample,GET https://123.123.123.123/vCenter-CB/api/hierarchies?version=1.0.1
Table 1-2. Components of Error Elements
Element Description
majorErrorCode Theclassoftheerror.ItrepresentstheHTTPStatuscodes.
minorErrorCode ThespecificAPIerrorcode.Forexample,itcanindicatethathierarchycreationfailed.
vendorSpecificErrorCode
(Optional)
Avendor/implementationspecificerrorcodethatpointstospecificmodules/partsofthe
codeandcanmakeproblemdiagnosticseasier.Forexample,itcanindicate
ifacode
snippetisavCentererrorcodeoraDatabaseerrorcode.
message Aone‐line,human‐readablemessagethatdescribestheerrorthatoccurred.
ErrorStackTrace ThiselementispresentwhentheloglevelinChargebackissettoDebug.
Table 1-3. Common Elements
Element Description
Request AnAPIrequeststartswiththiselement.
Response AnAPIresponsestartswiththiselement.
status DenoteswhetherAPIissuccessfullyexecuted.
IsValidLicense Indicatesthestatusofthelicense.Valuecanbetrueorfalse.
Table 1-4. API Syntax Components
Syntax Component Description
HTTP_request_method PUT,POST,GET,orDELETE
Base_Url, TheURLoftheChargebackhost.ThebaseURLforvCenterChargebackAPIsis:
https://<Chargeback server IP>/vCenter-CB/api
Forexample,https://123.123.123.123/vCenter-CB/api
API_signature TheURLpathforaChargebackAPI.Forexample,/hierarchiesretrievesthe
hierarchiesaddedtotheChargebackserverrunningon123.123.123.123.
version APIversion.ForChargebackserver1.0.1,itneedsto
bepassedas1.0.1.