Apache CloudStack 4.15.0.0 Root Admin API Reference

listUsageRecords

Lists usage records for accounts

Request parameters

Parameter NameDescriptionRequired
enddateEnd date range for usage record query (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).true
startdateStart date range for usage record query (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).true
accountList usage records for the specified user.false
accountidList usage records for the specified accountfalse
domainidList usage records for the specified domain.false
includetagsFlag to enable display of Tags for a resourcefalse
keywordList by keywordfalse
oldformatFlag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.false
pagefalse
pagesizefalse
projectidList usage records for specified projectfalse
typeList usage records for the specified usage typefalse
usageidList usage records for the specified usage UUID. Can be used only together with TYPE parameter.false

Response Tags

Response NameDescription
accountthe user account name
accountidthe user account Id
cpunumbernumber of cpu of resource
cpuspeedspeed of each cpu of resource
descriptiondescription of the usage record
domainthe domain the resource is associated with
domainidthe domain ID
enddateend date of the usage record
isdefaultTrue if the resource is default
issourcenatTrue if the IPAddress is source NAT
issystemTrue if the IPAddress is system IP - allocated during vm deploy or lb rule create
memorymemory allocated for the resource
nameresource or virtual machine name
networkidid of the network
offeringidoffering ID
ostypeidvirtual machine os type id
projectthe project name of the resource
projectidthe project id of the resource
rawusageraw usage in hours
sizeresource size
startdatestart date of the usage record
templateidtemplate ID
typeresource type
usageusage in hours
usageidid of the resource
usagetypeusage type ID
virtualmachineidvirtual machine ID
virtualsizevirtual size of resource
vpcidid of the vpc
zoneidthe zone ID