VMware VCENTER CHARGEBACK 1.5 - API User manual
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
Copyright © 2009, 2010 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and
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
AboutThisBook 5
1vCenterChargebackAPIs 7
WhatIsvCenterChargeback? 7
RESTArchitecture 7
Requests 8
Responses 8
CommonElementsintheRequestandResponseXMLs 9
ChargebackAPISyntax 9
APIVersioning 10
2UnderstandingtheWorkflow 11
RequirementsforCodeExamples 11
JARFiles 11
CommonUtilClass 12
FakeSSLCertificateSocketFactoryClass 13
LogIntovCenterChargebackServer 14
AddvCenterServerInformation 15
AddaCustomChargebackHierarchy 16
AddavCenterServerEntitytotheChargebackHierarchy 17
AddaFixedCost 19
ModifyaFixedCostValue 20
GenerateaReport 21
3UsingvCenterChargebackwithaBillingSystem 23
RequirementsforCodeExamples 23
JARFiles 23
CommonUtilClass 24
FakeSSLCertificateSocketFactoryClass 25
AddCostModels 26
AddaBillingPolicy 27
RetrieveListofHierarchies 28
GetDetailsofaHierarchy 29
AddReportScheduleforHierarchy 30
GetReportSchedulebyHierarchyName 33
RescheduleaReport 35
DeleteReportSchedule 36
GetListofArchivedReportsforaHierarchy 37
GetaReportasXML 38
Index 41
vCenter Chargeback API Programming Guide
4VMware, Inc.
VMware, Inc. 5
ThevCenterChargebackAPIProgrammingGuideprovidesinformationonhowtousevCenterChargebackAPIs.
Intended Audience
ThisbookisintendedforanyonewhodevelopapplicationstoworkwithvCenterChargeback.
VMware Technical Publications Glossary
VMwareTechnicalPublicationsprovidesaglossaryoftermsthatmightbeunfamiliartoyou.Fordefinitions
oftermsastheyareusedinVMwaretechnicaldocumentationgotohttp://www.vmware.com/support/pubs.
Document Feedback
VMwarewelcomesyoursuggestionsforimprovingourdocumentation.Ifyouhavecomments,sendyour
feedbacktodocfeedback@vmware.com.
vCenter Chargeback Documentation
ThevCenterChargebackdocumentationcomprisesthefollowingguides:
vCenterChargebackUser’sGuide
vCenterChargebackAPIProgrammingGuide
vCenterChargebackAPIReferenceGuide
Technical Support and Education Resources
Thefollowingsectionsdescribethetechnicalsupportresourcesavailabletoyou.Toaccessthecurrentversion
ofthisbookandotherbooks,gotohttp://www.vmware.com/support/pubs.
Online and Telephone Support
Touseonlinesupporttosubmittechnicalsupportrequests,viewyourproductandcontractinformation,and
registeryourproducts,gotohttp://www.vmware.com/support.
Customerswithappropriatesupportcontractsshouldusetelephonesupportforthefastestresponseon
priority1issues.Gotohttp://www.vmware.com/support/phone_support.
Support Offerings
TofindouthowVMwaresupportofferingscanhelpmeetyourbusinessneeds,goto
http://www.vmware.com/support/services.
About This Book
vCenter Chargeback API Programming Guide
6VMware, Inc.
VMware Professional Services
VMwareEducationServicescoursesofferextensivehands‐onlabs,casestudyexamples,andcoursematerials
designedtobeusedason‐the‐jobreferencetools.Coursesareavailableonsite,intheclassroom,andlive
online.Foronsitepilotprograms andimplementationbestpractices,VMwareConsultingServicesprovides
offeringsto helpyouassess,plan,build,andmanageyourvirtualenvironment.Toaccessinformationabout
educationclasses,certificationprograms,andconsultingservices,gotohttp://www.vmware.com/services.
VMware, Inc. 7
1
Thischapterincludesthefollowingtopics:
“WhatIsvCenterChargeback?”onpage 7
“RESTArchitecture”onpage 7
“ChargebackAPISyntax”onpage 9
“A P I Versioning”onpage 10
What Is vCenter Chargeback?
vCenterChargebackisacostreportingsolutionforenvironmentsvirtualizedusingvSphere.ThisWeb‐based
applicationinteractswiththevCenterDatabasetoretrieveusageinformation,calculatesthecostbyusingthe
definedChargebackformulas,andgeneratesreports.
vCenterChargebackrunsonanApacheTomcatserverinstance.TheuserinteractswiththevCenter
Chargebackapplicationthroughaloadbalancer(ApacheHTTPServer).vCenterChargebackconnectstoa
Chargebackdatabasethatstoresinformationsuchasthedefinedhierarchies,costmodel,users,roles,andso
on.TheapplicationalsointeractswiththevCenterServerandvCenterDatabasethroughaDataCollector.The
DataCollectorusesVIMAPIstocommunicatewiththevCenterServerandJDBCtocommunicatewiththe
vCenterDatabase.
vCenterChargebackAPIsprovideaninterfaceforapplicationdeveloperstoprogrammaticallyusethe
functionalityofvCenterChargeback.
FormoreinformationaboutChargebackanditscapabilities,seethevCenterChargebackUser’sGuide.
REST Architecture
vCenterChargebackAPIsimplementtheRepresentationalStateTransfer(REST)architecture.REST‐based
APIshelpyousendHTTPrequestsforresourcesoverthenetworkandreceiveresponses.
vCenter Chargeback APIs 1
vCenter Chargeback API Programming Guide
8VMware, Inc.
Figure 1-1. REST Architecture in vCenter Chargeback
Requests
AnHTTPrequestsentbyaChargebackAPIcanbeofthefollowingtype:PUT,POST,GET,orDELETE.
Table 1‐1showshoweachoftheserequesttypesmapstoastandardCRUDoperation.
AlongwiththeHTTPrequests,youcanpassrequestparametersbyusingXMLs.AnexamplerequestXMLfor
theLoginAPIisprovidedhere.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Request xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0">
<Users>
<User>
<Name>admin</Name>
<Password>ttt</Password>
<Type>local</Type>
</User>
</Users>
</Request>
Responses
WhenanAPItaskissuccessful,thevalueofthestatusparameterintheresponseXMLissettosuccessas
showninthefollowingexample.
<?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">
<Hierarchies>
<Hierarchy id="1">
...
</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
IfanAPItaskisunsuccessful,thestatusparameterissettofailureandtheErrorelementcapturesallthe
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‐2explainsthecomponentsoftheErrorelement.
Common Elements in the Request and Response XMLs
Table 1‐3presentsthecommonXMLelementsusedbytherequestandresponseXMLs.
ForanexamplerequestXML,see“Requests.”ForanexampleresponseXML,see“Responses.”
Chargeback API Syntax
EachvCenterChargebackAPIhasthefollowingsyntax:
<HTTP_request_method> <Base_Url>/<API_signature>
Forexample,GET https://123.123.123.123/vCenter-CB/api/hierarchies
Table 1‐4describesthecomponentsofvCenterChargebackAPIsyntax.
Table 1-2. Components of Error Element
Element Description
majorErrorCode Theclassoftheerror.ItrepresentstheHTTPStatuscodes.
minorErrorCode TheAPIerrorcode.Forexample,itcanindicatethathierarchycreationfailed.
vendorSpecificErrorCode
(Optional)
Avendororimplementation‐specificerrorcodethatpointstospecificmodulesorparts
ofthecode,andcanmakeproblemdiagnosticseasier.Forexample,itcanindicateifa
codesnippetisavCentererrorcodeoradatabaseerrorcode.
message Aone‐line,human‐readablemessagethatdescribestheerrorthatoccurred.
ErrorStackTrace ThiselementispresentwhentheloglevelinChargebackissettoDebug.
Table 1-3. Common Elements
Element Description
Request AnAPIrequeststartswiththiselement.
Response AnAPIresponsestartswiththiselement.
status DenoteswhetherAPIissuccessfullyexecuted.
IsValidLicense Indicatesthestatusofthelicense.Valuecanbetrueorfalse.
Table 1-4. API Syntax Components
Syntax Component Description
HTTP_request_method PUT,POST,GET,orDELETE
Base_Url TheURLoftheChargebackhost.ThebaseURLforvCenterChargebackAPIsis:
https://<Chargeback server IP>/vCenter-CB/api
Forexample,https://123.123.123.123/vCenter-CB/api
API_signature TheURLpathforaChargebackAPI.Forexample,/hierarchiesretrievesthe
hierarchiesaddedtotheChargebackserverrunningon123.123.123.123.
version (Optional)APIversion.IfyouneedtouseChargebackserver1.0.1,specifytheversion
as1.0.1.Ifyoudonotspecifytheversion,theAPIversionwillbeconsideredas1.5.0.
vCenter Chargeback API Programming Guide
10 VMware, Inc.
IfyouwanttousevCenterChargeback1.0.1APIs,youneedtodothefollowingtasks:
IntheAPIURL,specifyversion=1.0.1.
Forexample,<HTTP_request_method> <Base_Url>/<API_signature>?version=1.0.1
IntherequestXML,updatetherequestelementwiththefollowingtag:
<Request xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0">
API Versioning
EveryvCenterChargeback1.5.0APIrequestandresponseincludestargetnamespacetodenotetheAPI
version.For example,thefollowingrequestXMLsendstheversionwithwhichitisworking.
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0">
<Hierarchies>
<Hierarchy>
<Name>Test_Hierarchy</Name>
<Description>Test Hierarchy</Description>
</Hierarchy>
</Hierarchies>
</Request>
TherequeststatesthatvCenterChargebackAPIversion1.5.0isbeingcalled.IftherequestisforvCenter
Chargebackserverversion1.0.1,thecallfails.IftherequestisforvCenterChargebackserver1.5.0,thecall
succeedsandgetsaresponsesimilartothefollowing.
<?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">
<Hierarchies>
<Hierarchy id="1174">
<Name>Test_Hierarchy</Name>
<Description>Test Hierarchy</Description>
<CreatedOn>1275033342320</CreatedOn>
<InSync>true</InSync>
<LastUpdatedTime>1275033342350</LastUpdatedTime>
<LastUpdatedUser>local\superuser</LastUpdatedUser>
<Entities>
<Entity id="1175">
<Name>Test_Hierarchy</Name>
<Description>Root</Description>
<Type>100</Type>
<Shares>
<Share>
<Percentage>100</Percentage>
<Parent id="-1" />
<StartTime>0</StartTime>
</Share>
</Shares>
</Entity>
</Entities>
</Hierarchy>
</Hierarchies>
</Response>
IfyouspecifytheAPIversion,besuretospecifyitwithboththerequestXML(whereverapplicable)andthe
URL.IfitisspecifiedonlyintherequestXMLortheURLandnotboth,thentheAPIresultsinanerror.Ifthe
APIversionisabsentinboththeURLandtherequestXML(whereverapplicable),thentheAPIreturnsthe
outputcorrespondingtothelatestversion.
VMware, Inc. 11
2
ThischapterexplainshowtoperformsomeofthebasicvCenterChargebacktasksusingtheAPIs.Youcan
createahierarchyandaddentities,addfixedcostandgenerateareportonresourceutilization.
Thechapterincludesthefollowingtopics:
“RequirementsforCodeExamples”onpage 11
“LogIntovCenterChargebackServer”onpage 14
“A d d vCenterServerInformation”onpage 15
“A d d aCustomChargebackHierarchy”onpage 16
“A d d avCenterServerEntitytotheChargebackHierarchy”onpage 17
“A d d aFixedCost”onpage 19
“ModifyaFixedCostValue”onpage 20
“GenerateaReport”onpage 21
Requirements for Code Examples
ThischapterprovidescodeexamplestoexplainhowyoucancalltheAPIs.Torunthesecodeexamples,you
requirethefollowingJARandhelperclassfiles.
JAR Files
ThecodeexamplesneedthefollowingJARfiles.
commons-httpclient-3.1.jar
commons-logging-1.1.1.jar
jdom.jar
YoumustplacetheseJARfilesintheclasspath.
Understanding the Workflow 2
vCenter Chargeback API Programming Guide
12 VMware, Inc.
CommonUtil Class
ThecodeexamplesusethefollowingCommonUtilclass.
public final class CommonUtil {
/**
* This method writes out a formatted XML document to the Writer out.
*
* @param doc
* @param out
* @throws IOException
*/
public static void printXML(Document doc, Writer out) throws IOException {
XMLOutputter o = new XMLOutputter();
Format newFormat = o.getFormat();
newFormat.setIndent(" ");
o.setFormat(newFormat);
o.output(doc, out);
}
/**
* This method returns the XML document as a string object
*
* @param doc JDOM document representation of the XML
* @return String representation of the XML document
* @throws IOException
*/
public static String xmlAsString(Document doc) throws IOException {
Writer w = new StringWriter();
printXML(doc, w);
return w.toString();
}
/**
* This method reads the XML from a file and returns its representation as a
* JDOM document
*
* @param filePath path to the XML file
* @return JDOM document representation of the XML
* @throws IOException
* @throws JDOMException
*/
public static Document getXMLDocument(String filePath) throws IOException, JDOMException {
FileInputStream fis = null;
try {
fis = new FileInputStream(filePath);
return getXMLDocument(fis);
} finally {
if (fis != null) {
fis.close();
}
}
}
/**
* This method reads an XML document from the input Stream and returns its
* JDOM document representation
*
* @param is input stream that has the XML content
* @return jDOM document representation for the XML
* @throws IOException
* @throws JDOMException
*/
private static Document getXMLDocument(InputStream is) throws IOException, JDOMException {
Document xml = null;
SAXBuilder builder = new SAXBuilder();
xml = builder.build(is);
return xml;
}
}
VMware, Inc. 13
Chapter 2 Understanding the Workflow
FakeSSLCertificateSocketFactory Class
ThecodeexamplesusethefollowingclasstoaccessresourcesovertheHTTPSprotocol.
/**
* Helper class to accept self-signed certificate.
*/
public class FakeSSLCertificateSocketFactory implements SecureProtocolSocketFactory {
private SSLContext sslContext;
public FakeSSLCertificateSocketFactory() throws NoSuchAlgorithmException,
KeyManagementException {
sslContext = SSLContext.getInstance("SSL");
sslContext.init(null, new TrustManager[] {new X509TrustManager() {
@Override
public void checkClientTrusted(X509Certificate[] ax509certificate, String s) throws
CertificateException {
// Allow.
}
@Override
public void checkServerTrusted(X509Certificate[] ax509certificate, String s) throws
CertificateException {
// Allow.
}
@Override
public X509Certificate[] getAcceptedIssuers() {
return new X509Certificate[0];
}
}}, null);
}
@Override
public Socket createSocket(String s, int i) throws IOException, UnknownHostException {
return sslContext.getSocketFactory().createSocket(s, i);
}
@Override
public Socket createSocket(String s, int i, InetAddress inetaddress, int j) throws
IOException, UnknownHostException {
return sslContext.getSocketFactory().createSocket(s, i, inetaddress, j);
}
@Override
public Socket createSocket(String s, int i, InetAddress inetaddress, int j,
HttpConnectionParams httpconnectionparams) throws IOException,
UnknownHostException, ConnectTimeoutException {
return sslContext.getSocketFactory().createSocket(s, i, inetaddress, j);
}
@Override
public Socket createSocket(Socket socket, String s, int i, boolean flag) throws IOException,
UnknownHostException {
return sslContext.getSocketFactory().createSocket(socket, s, i, flag);
}
}
vCenter Chargeback API Programming Guide
14 VMware, Inc.
Log In to vCenter Chargeback Server
TostartusingvCenterChargebackAPIs,youmustlogintovCenterChargebackserver.
To log in to vCenter Chargeback
1 CalltheLoginAPIbyusingthefollowingsyntax.
<HTTP_request_method> <Base_URL>/login
Forexample,youcandefineacallasfollows:
POST https://123.123.123.123/vCenter-CB/api/login
2 (Optional)UsetheURLparameterversiontospecifytheAPIversionthatyouwanttocall.
3IntherequestXMLforthisAPI,youcanspecifythefollowinglogindetails.
Usertype
Username
Password
LDAPserverIDorLDAPservername
ThefollowingisanexamplerequestXMLfile.
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0">
<Users>
<User>
<Type>userType</Type>
<Name>administrator</Name>
<Password>vmware</Password>
<!-- For LDap User you can either provide LdapServer id or ldap server name
-->
<LdapServer id=”1”/>
</User>
</Users>
<!-- For Ldap Users -->
<LdapServers>
<LdapServer>
<LdapServerName>vmw</LdapServerName>
</LdapServer>
</LdapServers>
</Request>
Iftheloginsucceeds,theAPIreturnsaresponseXMLthatindicateswhethertheuserisauthenticated.
ThefollowingisanexampleprogramthatcallstheAPI.
/**
* This method is for Login to vCenter-ChargeBack
*
* @param requestFilePath
* @param baseURL
* @param version
* @throws IOException
* @throws JDOMException
* @throws NoSuchAlgorithmException
* @throws KeyManagementException
* @throws HttpException
*/
public static void sampleLoginMethod(String requestFilePath, String baseURL, String
version) throws IOException, JDOMException,
NoSuchAlgorithmException, KeyManagementException, HttpException {
PostMethod post = null;
NameValuePair[] parameters = {new NameValuePair("version", version)};
Document requestDocument = CommonUtil.getXMLDocument(requestFilePath);
String bodyString = CommonUtil.xmlAsString(requestDocument);
HttpClient client = new HttpClient();
VMware, Inc. 15
Chapter 2 Understanding the Workflow
Protocol.registerProtocol("https", new Protocol("https", (ProtocolSocketFactory) new
FakeSSLCertificateSocketFactory(), 443));
String uri = "https://" + baseURL + "/vCenter-CB/api/login";
System.out.println(uri);
try {
post = new PostMethod(uri);
post.setQueryString(parameters);
post.setRequestBody(bodyString);
client.executeMethod(post);
System.out.println(post.getResponseBodyAsString());
} finally {
if (post != null) {
post.releaseConnection();
}
}
}
Add vCenter Server Information
YoucanaddthevCenterServerinstancesinyourvirtualizedenvironmenttovCenterChargeback.Thishelps
determinethecomputingresourceutilizationforthevirtualmachinesandcalculatethetotalcosts.
To add vCenter Server information
1 CalltheAPIbyusingthefollowingsyntax.
<HTTP_request_method> <Base_URL>/vCenterServer
Forexample,youcandefineacallasfollows:
POST https://123.123.123.123/vCenter-CB/api/vCenterServer
2IntherequestXML,specifythefollowinginformation:
vCenterServerURL
vCenterServerName
vCenterServerDescription
vCenterServerUsername
vCenterServerPassword
PluginRegistered
StatsSync
DatasourceURL
DataSourceName
DataSourceUserName
DataSourcePassword
DataSourceType
DataSourceAuthType
ThefollowingisanexamplerequestXML.
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0">
<VCenterServers>
<VCenterServer>
<Url>101.102.107.21:443</Url>
<Name>vc1</Name>
<Description>vc1</Description>
<UserName>administrator</UserName>
<Password>xxxx</Password>
<PluginRegistered>true</PluginRegistered>
<StatsSync>true</StatsSync>
<DataSourceUrl>
10.112.107.21\sqlexp_vim
vCenter Chargeback API Programming Guide
16 VMware, Inc.
</DataSourceUrl>
<DataSourceName>vim_vcdb</DataSourceName>
<DataSourceUserName>sa</DataSourceUserName>
<DataSourcePassword>xxxx</DataSourcePassword>
<DataSourceType id="1" />
<DataSourceAuthType id="1" />
<ForceUpdate>false</ForceUpdate>
</VCenterServer>
</VCenterServers>
</Request>
IfthevCenterServerissuccessfullyadded,theAPIreturnsanXMLresponsethatprovidesthevCenter
ServerID.
ThefollowingisanexampleprogramthatcallstheAPI.
/**
* This method is to add the vCenter-Server in vCenter-Chargeback application
*
* @param requestFilePath
* @param baseURL
* @throws IOException
* @throws JDOMException
* @throws NoSuchAlgorithmException
* @throws KeyManagementException
* @throws HttpException
*/
public static void sampleAddVCenterServerMethod(String requestFilePath, String baseURL)
throws IOException, JDOMException, NoSuchAlgorithmException,
KeyManagementException, HttpException {
PostMethod post = null;
Document requestDocument = CommonUtil.getXMLDocument(requestFilePath);
String bodyString = CommonUtil.xmlAsString(requestDocument);
HttpClient client = new HttpClient();
Protocol.registerProtocol("https", new Protocol("https", (ProtocolSocketFactory) new
FakeSSLCertificateSocketFactory(), 443));
String uri = "https://" + baseURL + "/vCenter-CB/api/vCenterServer";
System.out.println(uri);
System.out.println(bodyString);
try {
post = new PostMethod(uri);
post.setRequestBody(bodyString);
client.executeMethod(post);
System.out.println(post.getResponseBodyAsString());
} finally {
if (post != null) {
post.releaseConnection();
}
}
}
Add a Custom Chargeback Hierarchy
UsetheAddaChargebackHierarchyAPItocreateahierarchywiththegivennameanddescription.
To add a custom Chargeback hierarchy
1 CalltheAPIbyusingthefollowingsyntax.
<HTTP_request_method> <Base_URL>/hierarchy
Forexample,youcandefineacalllikethis:
POST https://123.123.123.123/vCenter-CB/api/hierarchy
2IntherequestXML,specifyanameandadescriptionforthehierarchy.
VMware, Inc. 17
Chapter 2 Understanding the Workflow
ThefollowingisanexamplerequestXML.
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0">
<Hierarchies>
<Hierarchy>
<Name>Test_Hierarchy</Name>
<Description>Test Hierarchy</Description>
</Hierarchy>
</Hierarchies>
</Request>
Ifsuccessful,theAPIreturnsdetailsofthenewhierarchy.
ThefollowingisanexampleprogramthatcallstheAPI.
/**
* This method is to add a vCenter-ChargeBack hierarchy in
* vCenter-ChargeBack
*
* @param requestFilePath
* @param baseURL
* @throws IOException
* @throws JDOMException
* @throws NoSuchAlgorithmException
* @throws KeyManagementException
* @throws HttpException
*/
public static void sampleAddHierarchyMethod(String requestFilePath, String baseURL)
throws IOException, JDOMException, NoSuchAlgorithmException,
KeyManagementException, HttpException {
PostMethod post = null;
Document requestDocument = CommonUtil.getXMLDocument(requestFilePath);
String bodyString = CommonUtil.xmlAsString(requestDocument);
Protocol.registerProtocol("https", new Protocol("https", (ProtocolSocketFactory) new
FakeSSLCertificateSocketFactory(), 443));
HttpClient client = new HttpClient();
String uri = "https://" + baseURL + "/vCenter-CB/api/hierarchy";
System.out.println(uri);
System.out.println(bodyString);
try {
post = new PostMethod(uri);
post.setRequestBody(bodyString);
client.executeMethod(post);
System.out.println(post.getResponseBodyAsString());
} finally {
if (post != null) {
post.releaseConnection();
}
}
}
Add a vCenter Server Entity to the Chargeback Hierarchy
ThistaskhelpsyouaddavCenterServerentityunderaspecifiedparententityinaChargebackhierarchy.
To add a vCenter Server entity to the Chargeback hierarchy
1 CalltheAPIbyusingthefollowingsyntax.
<HTTP_request_method> <Base_URL>/hierarchy/{hierarchyId}/entity/{parentEntityId}
Forexample,youcandefineacalllikethis:
POST https://123.123.123.123/vCenter-CB/api/hierarchy/11/entity/101
2IntherequestXML,specifythehierarchyID,entityname,anddescriptionforthehierarchy.
vCenter Chargeback API Programming Guide
18 VMware, Inc.
ThefollowingisanexamplerequestXML.
<?xml version="1.0" encoding="UTF-8"?>
<Request>
<VCenterServers>
<VCenterServer id="502">
<VCenterServerView id = "2"/>
<Entities>
<Entity id="1062"/>
</Entities>
</VCenterServer>
</VCenterServers>
</Request>
Ifsuccessful,theAPIreturnsanXMLfilethatindicatesthestatus.
ThefollowingisanexampleprogramthatcallstheAPI.
/**
* This method is for adding a new vCenter-Server entity under
* vCenter-Chargeback Hierarchy entity
*
* @param requestFilePath
* @param baseURL
* @param hierachyId
* @param CBEntityId
* @throws IOException
* @throws JDOMException
* @throws NoSuchAlgorithmException
* @throws KeyManagementException
* @throws HttpException
*/
public static void sampleAddNewVCenterServerEntity(String requestFilePath, String
baseURL, int hierachyId, int CBEntityId, long startTime)
throws IOException, JDOMException, NoSuchAlgorithmException,
KeyManagementException, HttpException {
PostMethod post = null;
Document requestDocument = CommonUtil.getXMLDocument(requestFilePath);
NameValuePair[] parameters = {new NameValuePair("startTime",
String.valueOf(startTime))};
String bodyString = CommonUtil.xmlAsString(requestDocument);
Protocol.registerProtocol("https", new Protocol("https", (ProtocolSocketFactory) new
FakeSSLCertificateSocketFactory(), 443));
String uri = "https://" + baseURL + "/vCenter-CB/api/hierarchy/" + hierachyId +
"/entity/" + CBEntityId;
HttpClient client = new HttpClient();
System.out.println(uri);
System.out.println(bodyString);
try {
post = new PostMethod(uri);
post.setQueryString(parameters);
post.setRequestBody(bodyString);
client.executeMethod(post);
System.out.println(post.getResponseBodyAsString());
} finally {
if (post != null) {
post.releaseConnection();
}
}
}
VMware, Inc. 19
Chapter 2 Understanding the Workflow
Add a Fixed Cost
Afixedcostisadefinitecostthatcanbechargedonanentity.UsingtheAddFixedCostAPI,youcancreate
fixedcostsforentities.
To add a fixed cost
1 CalltheAPIusingthefollowingsyntax.
<HTTP_request_method> <Base_URL>/fixedCost
Forexample,youcandefineacalllikethis:
POST https://123.123.123.123/vCenter-CB/api/fixedCost
2IntherequestXML,specifyanameandadescriptionforthefixedcost.
ThefollowingisanexamplerequestXML.
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0">
<FixedCosts>
<FixedCost>
<Name>Fixed Cost 1</Name>
<Description>Fixed Cost 1 description</Description>
<Currency id="1"/>
</FixedCost>
</FixedCosts>
</Request>
Ifthetaskissuccessful,theAPIreturnsanXMLfilethatprovidesdetailsofthenewfixedcost.
ThefollowingisanexampleprogramthatcallstheAPI.
/**
* This method is to add a fixed cost in vCenter-ChargeBack
*
* @param requestFilePath
* @param baseURL
* @throws IOException
* @throws JDOMException
* @throws NoSuchAlgorithmException
* @throws KeyManagementException
* @throws HttpException
*/
public static void sampleAddFixedCost(String requestFilePath, String baseURL) throws
IOException, JDOMException, NoSuchAlgorithmException,
KeyManagementException, HttpException {
PostMethod post = null;
Document requestDocument = CommonUtil.getXMLDocument(requestFilePath);
String bodyString = CommonUtil.xmlAsString(requestDocument);
HttpClient client = new HttpClient();
Protocol.registerProtocol("https", new Protocol("https", (ProtocolSocketFactory) new
FakeSSLCertificateSocketFactory(), 443));
String uri = "https://" + baseURL + "/vCenter-CB/api/fixedCost";
try {
post = new PostMethod(uri);
post.setRequestBody(bodyString);
client.executeMethod(post);
System.out.println(post.getResponseBodyAsString());
} finally {
if (post != null) {
post.releaseConnection();
}
}
}
vCenter Chargeback API Programming Guide
20 VMware, Inc.
Modify a Fixed Cost Value
UsingtheModifyFixedCostAPI,youcanupdatetheID,value,anddurationforafixedcost.
To modify a fixed cost value
1 CalltheAPIbyusingthefollowingsyntax.
<HTTP_request_method> <Base_URL>/fixedCost/{fixedCostId}/values
Forexample,youcandefineacalllikethis:
PUT https://123.123.123.123/vCenter-CB/api/fixedCost/{fixedCostId}/values
2IntherequestXML,specifyanameandadescriptionforthefixedcost.Thefollowingisanexample
requestXML.
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0">
<FixedCosts>
<FixedCost id="1">
<Values>
<Value>
<Cost>3.1415</Cost>
<Duration id="1"/>
</Value>
</Values>
</FixedCost>
</FixedCosts>
</Request>
TheresponseXMLindicateswhetherthefixedcostvaluewassuccessfullymodified.
ThefollowingisanexampleprogramthatcallstheAPI.
/**
* This method is to modify the values of an existing fixedCost
*
* @param requestFilePath
* @param baseURL
* @param startTime
* @param endTime
* @throws IOException
* @throws JDOMException
* @throws NoSuchAlgorithmException
* @throws KeyManagementException
* @throws HttpException
*/
public static void sampleModifyFixedCostValues(String requestFilePath, String baseURL,
int fixedCostId, long startTime, long endTime) throws IOException,
JDOMException, NoSuchAlgorithmException, KeyManagementException, HttpException {
PutMethod put = null;
Document requestDocument = CommonUtil.getXMLDocument(requestFilePath);
String bodyString = CommonUtil.xmlAsString(requestDocument);
Protocol.registerProtocol("https", new Protocol("https", (ProtocolSocketFactory) new
FakeSSLCertificateSocketFactory(), 443));
HttpClient client = new HttpClient();
String uri = "https://" + baseURL + "/vCenter-CB/api/fixedCost/" + fixedCostId +
"/values";
System.out.println(uri);
NameValuePair[] parameters = {new NameValuePair("startTime",
String.valueOf(startTime)), new NameValuePair("endTime",
String.valueOf(endTime))};
try {
put = new PutMethod(uri);
put.setRequestBody(bodyString);
put.setQueryString(parameters);
client.executeMethod(put);
System.out.println(put.getResponseBodyAsString());
Other manuals for VCENTER CHARGEBACK 1.5 - API
2
Table of contents
Other VMware Software manuals
VMware
VMware COMPLIANCE CHECKER - DATASHEET FOR PCI DSS... User manual
VMware
VMware VS4-STD-C - vSphere Standard - PC Instruction sheet
VMware
VMware CLOUD DIRECTOR 1.0 User manual
VMware
VMware APPSPEED SERVER 1.5 - VCENTER APPSPEED INSTALLATION... User manual
VMware
VMware ESX 4.0 - GETTING STARTED UPDATE 1 User manual
VMware
VMware VCLOUD SDK 1.0 - FOR NET DEVELOPERS GUIDE User manual
VMware
VMware GSX Server 3 Administration Instruction Manual
VMware
VMware VCLOUD DIRECTOR User manual
VMware
VMware VCENTER APPLICATION DISCOVERY MANAGER User manual
VMware
VMware vSphere 4 Installation and operation manual
VMware
VMware VSHIELD APP 1.0.0 UPDATE 1 - API User manual
VMware
VMware VCENTER CAPACITYIQ 1.5 User manual
VMware
VMware CLOUD COMPUTING - User manual
VMware
VMware ESX 4.0 - GETTING STARTED UPDATE 1 General instructions
VMware
VMware ACE Use and care manual
VMware
VMware VCENTER CHARGEBACK 1.5 - API User manual
VMware
VMware vSphere 4 User manual
VMware
VMware VCENTER APPLICATION DISCOVERY MANAGER 6.1 -... User manual
VMware
VMware vSphere ESXi 4.0 Programming manual
VMware
VMware VSHIELD EDGE User manual
Popular Software manuals by other brands
Sony
Sony PEGA-GC10 instruction manual
Dell
Dell External OEMR 850 user guide
Brocade Communications Systems
Brocade Communications Systems PowerConnect B-RX release note
Intergraph
Intergraph InterServe Web quick start guide
Amanda
Amanda Amanda Portal Telephone Features System reference manual
Avaya
Avaya Interaction Center user guide
Lexicon
Lexicon STUDIO - ADDENDUM manual
Novell
Novell EDIRECTORY 8.8 SP5 installation guide
Dymo
Dymo LabelWriter 450 installation guide
Mylex
Mylex PCI Disk Array Controller Drivers 08P4100 Installation and user guide
Skyview
Skyview CMS user manual
Epson
Epson Panorama Stitcher Light EP and QuickTime 5 Reference manual