Apache CloudStack 4.0.0-incubating Root Admin API Reference

createVolume

Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.

Request parameters

Parameter NameDescriptionRequired
namethe name of the disk volumetrue
accountthe account associated with the disk volume. Must be used with the domainId parameter.false
diskofferingidthe ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.false
domainidthe domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.false
projectidthe project associated with the volume. Mutually exclusive with account parameterfalse
sizeArbitrary volume sizefalse
snapshotidthe snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.false
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
statusthe status of the 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
tags(*)the list of resource tags associated with volume
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value
jobidthe ID of the latest async job acting on this object
jobstatusthe current status of the latest async job acting on this object