Apache CloudStack v4.4.0 Domain Admin API Reference

createSnapshot

Creates an instant snapshot of a volume.

Request parameters

Parameter NameDescriptionRequired
volumeidThe ID of the disk volumetrue
accountThe account of the snapshot. The account parameter must be used with the domainId parameter.false
domainidThe domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.false
policyidpolicy id of the snapshot, if this is null, then use MANUAL_POLICY.false
quiescevmquiesce vm if truefalse

Response Tags

Response NameDescription
idID of the snapshot
accountthe account associated with the snapshot
created the date the snapshot was created
domainthe domain name of the snapshot's account
domainidthe domain ID of the snapshot's account
intervaltypevalid types are hourly, daily, weekly, monthy, template, and none.
namename of the snapshot
projectthe project name of the snapshot
projectidthe project id of the snapshot
revertableindicates whether the underlying storage supports reverting the volume to this snapshot
snapshottypethe type of the snapshot
statethe state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage
volumeidID of the disk volume
volumenamename of the disk volume
volumetypetype of the disk volume
zoneidid of the availability zone
tags(*)the list of resource tags associated with snapshot
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