Apache CloudStack 4.18.0.0 Root Admin API Reference

listVolumesMetrics

Lists volume metrics

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
clusteridthe cluster id the disk volume belongs tofalse
diskofferingidlist volumes by disk offeringfalse
displayvolumelist resources by display flag; only ROOT admin is eligible to pass this parameterfalse
domainidlist only resources belonging to the domain specifiedfalse
hostidlist volumes on specified hostfalse
idthe ID of the disk volumefalse
idsthe IDs of the volumes, mutually exclusive with idfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
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 false. Resources dedicated to a project are listed only if using the projectid parameter.false
listsystemvmslist system VMs; only ROOT admin is eligible to pass this parameterfalse
namethe name of the disk volumefalse
pagefalse
pagesizefalse
podidthe pod id the disk volume belongs tofalse
projectidlist objects by project; if projectid=-1 lists All VMsfalse
statestate of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.false
storageidthe ID of the storage pool, available to ROOT admin onlyfalse
tagsList resources by tags (key/value pairs)false
typethe type of disk volumefalse
virtualmachineidthe ID of the virtual machinefalse
zoneidthe ID of the availability zonefalse

Response Tags

Response NameDescription
diskiopstotalthe total disk iops
sizegbdisk size in GiB