Apache CloudStack Root Admin API Reference


Lists VM metrics

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
affinitygroupidlist vms by affinity groupfalse
detailscomma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to allfalse
displayvmlist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
domainidlist only resources belonging to the domain specifiedfalse
forvirtualnetworklist by network type; true if need to list vms using Virtual Network, false otherwisefalse
groupidthe group IDfalse
haenablelist by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabledfalse
hostidthe host IDfalse
hypervisorthe target hypervisor for the templatefalse
idthe ID of the virtual machinefalse
idsthe IDs of the virtual machines, mutually exclusive with idfalse
isoidlist vms by isofalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keypairlist vms by ssh keypair namefalse
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is falsefalse
namename of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)false
networkidlist by network idfalse
podidthe pod IDfalse
projectidlist objects by projectfalse
securitygroupidthe security group IDfalse
serviceofferingidlist by the service offeringfalse
statestate of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.false
storageidthe storage ID where vm's volumes belong tofalse
tagsList resources by tags (key/value pairs)false
templateidlist vms by templatefalse
useridthe user ID that created the VM and is under the account that owns the VMfalse
vpcidlist vms by vpcfalse
zoneidthe availability zone IDfalse

Response Tags

Response NameDescription
cputotalthe total cpu capacity in Ghz
diskiopstotalthe total disk iops
diskreaddisk read in MiB
diskwritedisk write in MiB
ipaddressthe VM's primary IP address
memorytotalthe total memory capacity in GiB
networkreadnetwork read in MiB
networkwritenetwork write in MiB