Apache CloudStack 4.0.0-incubating Root Admin API Reference

createSnapshot

Creates an instant snapshot of a volume.

Request parameters

Parameter Name	Description	Required
volumeid	The ID of the disk volume	true
account	The account of the snapshot. The account parameter must be used with the domainId parameter.	false
domainid	The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.	false
policyid	policy id of the snapshot, if this is null, then use MANUAL_POLICY.	false

Response Name	Description
id	ID of the snapshot
account	the account associated with the snapshot
created	the date the snapshot was created
domain	the domain name of the snapshot's account
domainid	the domain ID of the snapshot's account
intervaltype	valid types are hourly, daily, weekly, monthy, template, and none.
name	name of the snapshot
project	the project name of the snapshot
projectid	the project id of the snapshot
snapshottype	the type of the snapshot
state	the 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
volumeid	ID of the disk volume
volumename	name of the disk volume
volumetype	type of the disk volume
*tags()**	the list of resource tags associated with snapshot
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
jobid	the ID of the latest async job acting on this object
jobstatus	the current status of the latest async job acting on this object