VMware VCENTER CHARGEBACK 1.5

vCenter Chargeback API Programming

Guide

vCenter Chargeback 1.5

This document supports the version of each product listed and

supports all subsequent versions until the document is replaced

by a new edition. To check for more recent editions of this

document, see http://www.vmware.com/support/pubs.

EN-000404-00

You can find the most up-to-date technical documentation on the VMware Web site at:

http://www.vmware.com/support/

The VMware Web site also provides the latest product updates.

If you have comments about this documentation, submit your feedback to:

docfeedback@vmware.com

intellectual property laws. VMware products are covered by one or more patents listed at

http://www.vmware.com/go/patents.

VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks

and names mentioned herein may be trademarks of their respective companies.

VMware, Inc.

3401 Hillview Ave.

Palo Alto, CA 94304

www.vmware.com

2VMware, Inc.

vCenter Chargeback API Programming Guide

VMware, Inc. 3

Contents

AboutThisBook 5

1vCenterChargebackAPIs 7

WhatIsvCenterChargeback? 7

RESTArchitecture 7

Requests 8

Responses 8

CommonElementsintheRequestandResponseXMLs 9

ChargebackAPISyntax 9

APIVersioning 10

2UnderstandingtheWorkflow 11

RequirementsforCodeExamples 11

JARFiles 11

CommonUtilClass 12

FakeSSLCertificateSocketFactoryClass 13

LogIntovCenterChargebackServer 14

AddvCenterServerInformation 15

AddaCustomChargebackHierarchy 16

AddavCenterServerEntitytotheChargebackHierarchy 17

AddaFixedCost 19

ModifyaFixedCostValue 20

GenerateaReport 21

3UsingvCenterChargebackwithaBillingSystem 23

RequirementsforCodeExamples 23

JARFiles 23

CommonUtilClass 24

FakeSSLCertificateSocketFactoryClass 25

AddCostModels 26

AddaBillingPolicy 27

RetrieveListofHierarchies 28

GetDetailsofaHierarchy 29

AddReportScheduleforHierarchy 30

GetReportSchedulebyHierarchyName 33

RescheduleaReport 35

DeleteReportSchedule 36

GetListofArchivedReportsforaHierarchy 37

GetaReportasXML 38

Index 41

vCenter Chargeback API Programming Guide

4VMware, Inc.

VMware, Inc. 5

ThevCenterChargebackAPIProgrammingGuideprovidesinformationonhowtousevCenterChargebackAPIs.

Intended Audience

ThisbookisintendedforanyonewhodevelopapplicationstoworkwithvCenterChargeback.

VMware Technical Publications Glossary

VMwareTechnicalPublicationsprovidesaglossaryoftermsthatmightbeunfamiliartoyou.Fordefinitions

oftermsastheyareusedinVMwaretechnicaldocumentationgotohttp://www.vmware.com/support/pubs.

Document Feedback

VMwarewelcomesyoursuggestionsforimprovingourdocumentation.Ifyouhavecomments,sendyour

feedbacktodocfeedback@vmware.com.

vCenter Chargeback Documentation

ThevCenterChargebackdocumentationcomprisesthefollowingguides:

vCenterChargebackUser’sGuide

vCenterChargebackAPIProgrammingGuide

vCenterChargebackAPIReferenceGuide

Technical Support and Education Resources

Thefollowingsectionsdescribethetechnicalsupportresourcesavailabletoyou.Toaccessthecurrentversion

ofthisbookandotherbooks,gotohttp://www.vmware.com/support/pubs.

Online and Telephone Support

Touseonlinesupporttosubmittechnicalsupportrequests,viewyourproductandcontractinformation,and

Customerswithappropriatesupportcontractsshouldusetelephonesupportforthefastestresponseon

priority1issues.Gotohttp://www.vmware.com/support/phone_support.

Support Offerings

TofindouthowVMwaresupportofferingscanhelpmeetyourbusinessneeds,goto

http://www.vmware.com/support/services.

About This Book

vCenter Chargeback API Programming Guide

6VMware, Inc.

VMware Professional Services

VMwareEducationServicescoursesofferextensivehands‐onlabs,casestudyexamples,andcoursematerials

designedtobeusedason‐the‐jobreferencetools.Coursesareavailableonsite,intheclassroom,andlive

online.Foronsitepilotprograms andimplementationbestpractices,VMwareConsultingServicesprovides

offeringsto helpyouassess,plan,build,andmanageyourvirtualenvironment.Toaccessinformationabout

educationclasses,certificationprograms,andconsultingservices,gotohttp://www.vmware.com/services.

VMware, Inc. 7

Thischapterincludesthefollowingtopics:

“WhatIsvCenterChargeback?”onpage 7

“RESTArchitecture”onpage 7

“ChargebackAPISyntax”onpage 9

“A P I Versioning”onpage 10

What Is vCenter Chargeback?

vCenterChargebackisacostreportingsolutionforenvironmentsvirtualizedusingvSphere.ThisWeb‐based

applicationinteractswiththevCenterDatabasetoretrieveusageinformation,calculatesthecostbyusingthe

definedChargebackformulas,andgeneratesreports.

vCenterChargebackrunsonanApacheTomcatserverinstance.TheuserinteractswiththevCenter

Chargebackapplicationthroughaloadbalancer(ApacheHTTPServer).vCenterChargebackconnectstoa

Chargebackdatabasethatstoresinformationsuchasthedefinedhierarchies,costmodel,users,roles,andso

on.TheapplicationalsointeractswiththevCenterServerandvCenterDatabasethroughaDataCollector.The

DataCollectorusesVIMAPIstocommunicatewiththevCenterServerandJDBCtocommunicatewiththe

vCenterDatabase.

vCenterChargebackAPIsprovideaninterfaceforapplicationdeveloperstoprogrammaticallyusethe

functionalityofvCenterChargeback.

FormoreinformationaboutChargebackanditscapabilities,seethevCenterChargebackUser’sGuide.

REST Architecture

vCenterChargebackAPIsimplementtheRepresentationalStateTransfer(REST)architecture.REST‐based

APIshelpyousendHTTPrequestsforresourcesoverthenetworkandreceiveresponses.

vCenter Chargeback APIs 1

vCenter Chargeback API Programming Guide

8VMware, Inc.

Figure 1-1. REST Architecture in vCenter Chargeback

Requests

AnHTTPrequestsentbyaChargebackAPIcanbeofthefollowingtype:PUT,POST,GET,orDELETE.

Table 1‐1showshoweachoftheserequesttypesmapstoastandardCRUDoperation.

AlongwiththeHTTPrequests,youcanpassrequestparametersbyusingXMLs.AnexamplerequestXMLfor

theLoginAPIisprovidedhere.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<Users>

<User>

<Name>admin</Name>

<Type>local</Type>

</User>

</Users>

</Request>

Responses

WhenanAPItaskissuccessful,thevalueofthestatusparameterintheresponseXMLissettosuccessas

showninthefollowingexample.

<?xml version="1.0" encoding="UTF-8"?>

<Response status="success" isValidLicense="true"

xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

...

</Hierarchy>

</Hierarchies>

</Response>

Table 1-1. Request Type Mapping

Request Type CRUD Operation

POST CREATE

GET READ

PUT UPDATE/CREATE

DELETE DELETE

VMware, Inc. 9

Chapter 1 vCenter Chargeback APIs

IfanAPItaskisunsuccessful,thestatusparameterissettofailureandtheErrorelementcapturesallthe

details.

<?xml version="1.0" encoding="UTF-8"?>

<Response status="failure" isValidLicense="true"

xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<Error majorErrorCode="500" minorErrorCode="2014"

message="Hierarchy with id '1' does not exist." />

</Response>

Table 1‐2explainsthecomponentsoftheErrorelement.



Common Elements in the Request and Response XMLs

Table 1‐3presentsthecommonXMLelementsusedbytherequestandresponseXMLs.

ForanexamplerequestXML,see“Requests.”ForanexampleresponseXML,see“Responses.”

Chargeback API Syntax

EachvCenterChargebackAPIhasthefollowingsyntax:

<HTTP_request_method> <Base_Url>/<API_signature>

Forexample,GET https://123.123.123.123/vCenter-CB/api/hierarchies

Table 1‐4describesthecomponentsofvCenterChargebackAPIsyntax.

Table 1-2. Components of Error Element

Element Description

majorErrorCode Theclassoftheerror.ItrepresentstheHTTPStatuscodes.

minorErrorCode TheAPIerrorcode.Forexample,itcanindicatethathierarchycreationfailed.

vendorSpecificErrorCode

(Optional)

Avendororimplementation‐specificerrorcodethatpointstospecificmodulesor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.

IsValidLicense 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 (Optional)APIversion.IfyouneedtouseChargebackserver1.0.1,specifytheversion

as1.0.1.Ifyoudonotspecifytheversion,theAPIversionwillbeconsideredas1.5.0.

vCenter Chargeback API Programming Guide

10 VMware, Inc.

IfyouwanttousevCenterChargeback1.0.1APIs,youneedtodothefollowingtasks:

IntheAPIURL,specifyversion=1.0.1.

Forexample,<HTTP_request_method> <Base_Url>/<API_signature>?version=1.0.1

IntherequestXML,updatetherequestelementwiththefollowingtag:

API Versioning

EveryvCenterChargeback1.5.0APIrequestandresponseincludestargetnamespacetodenotetheAPI

version.For example,thefollowingrequestXMLsendstheversionwithwhichitisworking.

<?xml version="1.0" encoding="UTF-8"?>

<Name>Test_Hierarchy</Name>

<Description>Test Hierarchy</Description>

</Hierarchy>

</Hierarchies>

</Request>

TherequeststatesthatvCenterChargebackAPIversion1.5.0isbeingcalled.IftherequestisforvCenter

Chargebackserverversion1.0.1,thecallfails.IftherequestisforvCenterChargebackserver1.5.0,thecall

succeedsandgetsaresponsesimilartothefollowing.

<?xml version="1.0" encoding="UTF-8"?>

<Response xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" status="success"

isValidLicense="true">

<Name>Test_Hierarchy</Name>

<Description>Test Hierarchy</Description>

<LastUpdatedUser>local\superuser</LastUpdatedUser>

<Name>Test_Hierarchy</Name>

<Share>

</Share>

</Shares>

</Entity>

</Entities>

</Hierarchy>

</Hierarchies>

</Response>

IfyouspecifytheAPIversion,besuretospecifyitwithboththerequestXML(whereverapplicable)andthe

URL.IfitisspecifiedonlyintherequestXMLortheURLandnotboth,thentheAPIresultsinanerror.Ifthe

APIversionisabsentinboththeURLandtherequestXML(whereverapplicable),thentheAPIreturnsthe

outputcorrespondingtothelatestversion.

Other manuals for VCENTER CHARGEBACK 1.5 - API

Table of contents

Other VMware Software manuals

VMware

VMware VS4-ENT-PL-A - vSphere Enterprise Plus User manual

VMware

VMware DISK MOUNT UTILITY WORKSTATION 5.5 User manual

VMware

VMware VCLOUD SDK 1.0 - FOR NET DEVELOPERS GUIDE User manual

VMware

VMware THINAPP 4.6 - MIGRATING APPLICATIONS TECHNICAL... User guide

VMware

VMware VIEW 4.5 - ARCHITECTURE PLANNING... User manual

VMware

VMware VCENTER APPLICATION DISCOVERY MANAGER 6.1 -... User manual

VMware

VMware PACKAGE MANAGER 1.1 User manual

VMware

VMware VCLOUD API 1.0 - TECHNICAL NOTE Operating instructions

VMware

VMware ACE Use and care manual

VMware

VMware VIEW 4.5 User manual

VMware

VMware VCLOUD REQUEST MANAGER 1.0.0 User manual

VMware

VMware VLM3-ENG-CP - Lab Manager - PC User manual

VMware

VMware VCENTER APPLICATION DISCOVERY MANAGER 6.1.1 -... User manual

VMware

VMware VCENTER APPLICATION DISCOVERY MANAGER 6.1 -... Instruction Manual

VMware

VMware VSHIELD APP 1.0 - User manual

VMware

VMware VmWare ESX Server 2.12 Deployment Quick reference guide

VMware

VMware APPSPEED SERVER 1.5 - VCENTER APPSPEED INSTALLATION... Installation and operation manual

VMware

VMware 454885-B21 - Lab Manager Standard Foundation... User manual

VMware

VMware VIEW MANAGER 4.X - EXTENDING VIRTUAL MACHINE DELECTION WITH... User manual

VMware

VMware VCM 5.3 - TRANSPORT LAYER SECURITY... User manual

VMware

VMware ACE EN-000042-00 Use and care manual

VMware

VMware vSphere 4 User manual

VMware

VMware VSHIELD APP 1.0.0 UPDATE 1 - API Manual

VMware

VMware VSHIELD EDGE User manual

Popular Software manuals by other brands

COMPRO

COMPRO COMPROFM manual

Muratec

Muratec OFFICEBRIDGE ONLINE user guide

Oracle

Oracle Contact Center Anywhere 8.1 installation guide

Adobe

Adobe 65007312 - Photoshop Lightroom Programmer's guide

Avaya

Avaya NULL One-X for RIM Blackberry user guide

HP ProLiant BL420c user guide

PS Audio

PS Audio PowerPlay Programming manual

Brady

Brady LOCKOUT PRO 3.0 Administrator's guide

Avaya

Avaya Interaction Center user guide

Texas Instruments

Texas Instruments TI-83 Plus Silver Edition Guide book

Novell

Novell GROUPWISE 8 - INTERNET AGENT manual

Oracle

Oracle Application 9i Configuration guide

Acer

Acer RDM user guide

Canon

Canon Vixia HF21 instruction manual

Canon

Canon ZR950 instruction manual

Samsung

Samsung Auto Backup user manual

Polycom

Polycom Vortex EF2201 Application note

Brocade Communications Systems

Brocade Communications Systems Brocade 8/12c user manual

VMware VCENTER CHARGEBACK 1.5 - API User manual

Popular Software manuals by other brands