Apache CloudStack 4.23.0.0 Root Admin API Reference

listVolumes

Lists all volumes.

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
isencryptedlist only volumes that are encryptedfalse
isrecursiveDefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
kmskeyidList volumes by KMS Keyfalse
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 Instancesfalse
retrieveonlyresourcecountMakes the API's response contains only the resource countfalse
serviceofferingidList volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignoredfalse
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 Instancefalse
zoneidThe ID of the availability zonefalse

Response Tags

Response NameDescription
idID of the disk volume
accountThe Account associated with the disk volume
attachedThe date the volume was attached to an Instance
chaininfoThe chain info of the volume
clusteridCluster id of the volume
clusternameCluster name where the volume is allocated
createdThe date the disk volume was created
deleteprotectiontrue if volume has delete protection.
destroyedThe boolean state of whether the volume is destroyed or not
deviceidThe ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
diskBytesReadRateBytes read rate of the disk volume
diskBytesWriteRateBytes write rate of the disk volume
diskIopsReadRateIO requests read rate of the disk volume per the disk offering
diskIopsWriteRateIO requests write rate of the disk volume per the disk offering
diskioreadThe read (IO) of disk on the Instance
diskiowriteThe write (IO) of disk on the Instance
diskkbsreadThe Instance's disk read in KiB
diskkbswriteThe Instance's disk write in KiB
diskofferingdisplaytextThe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnameName of the disk offering
displayvolumeAn optional field whether to the display the volume to the end User or not.
domainThe domain associated with the disk volume
domainidThe ID of the domain associated with the disk volume
domainpathpath of the Domain the disk volume belongs to
encryptformatthe format of the disk encryption if applicable
externaluuidVolume UUID that is given by virtualisation provider (only for VMware)
hypervisorHypervisor the volume belongs to
isextractableTrue if the volume is extractable, false otherwise
isodisplaytextAn alternate display text of the ISO attached to the Instance
isoidThe ID of the ISO attached to the Instance
isonameThe name of the ISO attached to the Instance
kmskeyKMS key name of the volume
kmskeyidKMS key id of the volume
kmskeyversionVersion number of the KMS key used for disk encryption if applicable
maxiopsMax IOPS of the disk volume
miniopsMin IOPS of the disk volume
nameName of the disk volume
pathThe path of the volume
physicalsizeThe bytes actually consumed on disk
podidPod id of the volume
podnamePod name of the volume
projectThe project name of the VPN
projectidThe project id of the VPN
provisioningtypeProvisioning type used to create volumes.
quiescevmNeed quiesce Instance or not when taking Snapshot
serviceofferingdisplaytextThe display text of the service offering for root disk
serviceofferingidID of the service offering for root disk
serviceofferingnameName of the service offering for root disk
sizeSize of the disk volume
snapshotidID of the Snapshot from which this volume was created
stateThe state of the disk volume
statusThe status of the volume
storageName of the primary storage hosting the disk volume
storageidID of the primary storage hosting the disk volume; returned to admin User only
storagetypeShared or local storage
supportsstoragesnapshotTrue if storage Snapshot is supported for the volume, false otherwise
templatedisplaytextAn alternate display text of the Template for the Instance
templateidThe ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
templatenameThe name of the Template for the Instance
typeType of the disk volume (ROOT or DATADISK)
utilizationThe disk utilization
virtualmachineidID of the Instance
virtualsizeThe bytes allocated
vmdisplaynameDisplay name of the Instance
vmnameName of the Instance
vmstateState of the Instance
vmtypeType of the Instance
volumecheckresultdetails for the volume check result, they may vary for different hypervisors
volumerepairresultdetails for the volume repair result, they may vary for different hypervisors
zoneidID of the availability zone
zonenameName of the availability zone
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object