Apache CloudStack 4.15.0.0 Root Admin API Reference

listCapacity

Lists all the system wide capacities.

Request parameters

Parameter NameDescriptionRequired
clusteridlists capacity by the Cluster IDfalse
fetchlatestrecalculate capacities and fetch the latestfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
podidlists capacity by the Pod IDfalse
sortbySort the results. Available values: Usagefalse
typelists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.false
zoneidlists capacity by the Zone IDfalse

Response Tags

Response NameDescription
capacityallocatedthe capacity currently in allocated
capacitytotalthe total capacity available
capacityusedthe capacity currently in use
clusteridthe Cluster ID
clusternamethe Cluster name
namethe capacity name
percentusedthe percentage of capacity currently in use
podidthe Pod ID
podnamethe Pod name
typethe capacity type
zoneidthe Zone ID
zonenamethe Zone name