CloudStack v2.2.13 - 2.2.14 Domain Admin API Reference

listVolumes

Lists all volumes.

Request parameters

Parameter NameDescriptionRequired
hostidlist volumes on specified hostfalse
idthe ID of the disk volumefalse
namethe name of the disk volumefalse
podidthe pod id the disk volume belongs tofalse
projectidlist firewall rules by projectfalse
typethe type of disk volumefalse
virtualmachineidthe ID of the virtual machinefalse
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 a VM instance
createdthe date the disk volume was created
destroyedthe boolean state of whether the volume is destroyed or not
deviceidthe ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.
diskofferingdisplaytextthe display text of the disk offering
diskofferingidID of the disk offering
diskofferingnamename of the disk offering
domainthe domain associated with the disk volume
domainidthe ID of the domain associated with the disk volume
hypervisorHypervisor the volume belongs to
isextractabletrue if the volume is extractable, false otherwise
namename of the disk volume
projectthe project name of the vpn
projectidthe project id of the vpn
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
storagename of the primary storage hosting the disk volume
storagetypeshared or local storage
typetype of the disk volume (ROOT or DATADISK)
virtualmachineidid of the virtual machine
vmdisplaynamedisplay name of the virtual machine
vmnamename of the virtual machine
vmstatestate of the virtual machine
zoneidID of the availability zone
zonenamename of the availability zone