Apache CloudStack Root Admin API Reference


Lists clusters metrics

Request parameters

Parameter NameDescriptionRequired
allocationstatelists clusters by allocation statefalse
clustertypelists clusters by cluster typefalse
hypervisorlists clusters by hypervisor typefalse
idlists clusters by the cluster IDfalse
keywordList by keywordfalse
managedstatewhether this cluster is managed by cloudstackfalse
namelists clusters by the cluster namefalse
podidlists clusters by Pod IDfalse
showcapacitiesflag to display the capacity of the clustersfalse
zoneidlists clusters by Zone IDfalse

Response Tags

Response NameDescription
cpuallocatedthe total cpu allocated in Ghz
cpuallocateddisablethresholdcpu allocated disable threshold exceeded
cpuallocatedthresholdcpu allocated notification threshold exceeded
cpudisablethresholdcpu usage disable threshold exceeded
cpumaxdeviationthe maximum cpu deviation
cputhresholdcpu usage notification threshold exceeded
cputotalthe total cpu capacity in Ghz
cpuusedthe total cpu used in Ghz
hostsrunning / total hosts in the cluster
memoryallocatedthe total cpu allocated in GiB
memoryallocateddisablethresholdmemory allocated disable threshold exceeded
memoryallocatedthresholdmemory allocated notification threshold exceeded
memorydisablethresholdmemory usage disable threshold exceeded
memorymaxdeviationthe maximum memory deviation
memorythresholdmemory usage notification threshold exceeded
memorytotalthe total cpu capacity in GiB
memoryusedthe total cpu used in GiB
statestate of the cluster