Apache CloudStack 4.22.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 virtual machine.false
idsthe IDs of the virtual machines, mutually exclusive with id.false
keywordList by keywordfalse
namename of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).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 virtual machine
displaynameuser generated name. The name of the virtual machine is returned if no displayname exists.
namethe name of the virtual machine
stats(*)the list of VM stats
cpuusedthe amount (percentage) of the VM's CPU currently used
diskiopstotalthe total disk iops since the last stats retrieval
diskioreadthe VM's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration
diskiowritethe VM's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration
diskkbsreadthe VM's disk read in KiB
diskkbswritethe VM's disk write in KiB
memoryintfreekbsthe VM's free memory in KB or -1 if it cannot be gathered
memorykbsthe memory used by the VM in KB
memorytargetkbsthe target memory in VM (KB)
networkkbsreadthe incoming network traffic on the VM in KiB
networkkbswritethe outgoing network traffic on the host in KiB
networkreadthe amount of downloaded data by the VM in MiB
networkwritethe amount of uploaded data by the VM in MiB
timestampthe time when the VM stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'