Apache CloudStack 4.20.0.0 Root Admin API Reference

recoverVolume

Recovers a Destroy volume.

Request parameters

Parameter NameDescriptionRequired
idThe ID of the volumetrue

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
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 vm the volume is attahed 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 vm
diskiowritethe write (IO) of disk on the vm
diskkbsreadthe VM's disk read in KiB
diskkbswritethe VM'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 virtual machine
isoidthe ID of the ISO attached to the virtual machine
isonamethe name of the ISO attached to the virtual machine
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 vm 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
templatedisplaytext an alternate display text of the template for the virtual machine
templateidthe ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatenamethe name of the template for the virtual machine
typetype of the disk volume (ROOT or DATADISK)
utilizationthe disk utilization
virtualmachineidid of the virtual machine
virtualsizethe bytes allocated
vmdisplaynamedisplay name of the virtual machine
vmnamename of the virtual machine
vmstatestate of the virtual machine
vmtypetype of the virtual machine
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