Apache CloudStack 4.20.0.0 Root Admin API Reference

listStoragePools

Lists storage pools.

Request parameters

Parameter NameDescriptionRequired
clusteridlist storage pools belongig to the specific clusterfalse
hostidhost ID of the storage poolsfalse
idthe ID of the storage poolfalse
ipaddressthe IP address for the storage poolfalse
keywordList by keywordfalse
namethe name of the storage poolfalse
pagefalse
pagesizefalse
paththe storage pool pathfalse
podidthe Pod ID for the storage poolfalse
scopethe scope of the storage poolfalse
statusthe status of the storage poolfalse
storagecustomstatsIf true, lists the custom stats of the storage poolfalse
zoneidthe Zone ID for the storage poolfalse

Response Tags

Response NameDescription
idthe ID of the storage pool
allocatediopstotal min IOPS currently in use by volumes
capacityiopsIOPS CloudStack can provision from this storage pool
clusteridthe ID of the cluster for the storage pool
clusternamethe name of the cluster for the storage pool
createdthe date and time the storage pool was created
disksizeallocatedthe host's currently allocated disk size
disksizetotalthe total disk size of the storage pool
disksizeusedthe host's currently used disk size
hypervisorthe hypervisor type of the storage pool
ipaddressthe IP address of the storage pool
istagaruleWhether the informed tag is a JS interpretable rule or not.
managedwhether this pool is managed or not
namethe name of the storage pool
nfsmountoptsthe nfs mount options for the storage pool
overprovisionfactorthe overprovisionfactor for the storage pool
paththe storage pool path
podidthe Pod ID of the storage pool
podnamethe Pod name of the storage pool
providerStorage provider for this pool
scopethe scope of the storage pool
statethe state of the storage pool
storagecapabilitiesthe storage pool capabilities
storagecustomstatsthe storage pool custom stats
suitableformigrationtrue if this pool is suitable to migrate a volume, false otherwise
tagsthe tags for the storage pool
typethe storage pool type
zoneidthe Zone ID of the storage pool
zonenamethe Zone name of the storage pool
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object