Apache CloudStack 4.23.0.0 Root Admin API Reference

listVirtualMachinesUsageHistory

Lists VM stats

Request parameters

Parameter NameDescriptionRequired
enddateEnd date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")false
idThe ID of the Instance.false
idsThe IDs of the Instances, mutually exclusive with id.false
keywordList by keywordfalse
nameName of the Instance (a substring match is made against the parameter value returning the data for all matching Instances).false
pagefalse
pagesizefalse
startdateStart date to filter stats.Use format "yyyy-MM-dd hh:mm:ss")false

Response Tags

Response NameDescription
idThe ID of the Instance
displaynameUser generated name. The name of the Instance is returned if no displayname exists.
nameThe Name of the Instance
stats(*)The list of Instance stats
cpuusedThe amount (percentage) of the Instance's CPU currently used
diskiopstotalThe total disk IOPS since the last stats retrieval
diskioreadThe Instance's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration
diskiowriteThe Instance's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
memoryintfreekbsThe Instance's free memory in KB or -1 if it cannot be gathered
memorykbsThe memory used by the Instance in KB
memorytargetkbsThe target memory in Instance (KB)
networkkbsreadThe incoming Network traffic on the Instance in KiB
networkkbswriteThe outgoing Network traffic on the host in KiB
networkreadThe amount of downloaded data by the Instance in MiB
networkwriteThe amount of uploaded data by the Instance in MiB
timestampThe time when the Instance stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'