Apache CloudStack 4.18.0.0 Root Admin API Reference

extractVolume

Extracts volume

Request parameters

Parameter NameDescriptionRequired
idthe ID of the volumetrue
modethe mode of extraction - HTTP_DOWNLOAD or FTP_UPLOADtrue
zoneidthe ID of the zone where the volume is locatedtrue
urlthe url to which the volume would be extractedfalse

Response Tags

Response NameDescription
idthe id of extracted object
accountidthe account id to which the extracted object belongs
createdthe time and date the object was created
extractIdthe upload id of extracted object
extractModethe mode of extraction - upload or download
namethe name of the extracted object
statethe state of the extracted object
statusthe status of the extraction
storagetypetype of the storage
uploadpercentagethe percentage of the entity uploaded to the specified location
urlif mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded
zoneidzone ID the object was extracted from
zonenamezone name the object was extracted from