Snapshots

Create a snapshot

Create a snapshot of a specified volume.

post/diskgroups/{DgId}/volumes/{VolId}/snapshots

Request

Path parameters

DgIdstring required

Diskgroup identifier.

VolIdstring required

Name of the volume

Query parameters

nodenamestring

If specified, snapshot creation operation will be performed on the diskgroup from the indicated node. Else, a node where diskgroup is created will be chosen internally. Error will be returned for a nodename specified which does not has the particular diskgroup created.

Request body

SnapshotVolstring uri

Specifies a pre existing volume link that is to be used as a full-sized snapshot of the source volume.

SnapshotNamestring

Specifies the name of the new space-optimized or full-sized break-off snapshot volume that is to be created.

Type'full-instant' | 'space-optimized' | 'mirror-breakoff' required

Type of the snapshot

Commentstring

A description to be associated with the snapshot volume

CacheSizestring

Size of the cache to be created for use by a space-optimized snapshot

Cachestring

Cache object desired for space-optimised snapshot creation

Nmirrorinteger

Specifies the number of plexes in the original volume that are to be broken off for use as snapshot plexes.

Syncboolean

Specify false if synchronization is not to be started for a full-instant instant snapshot.

StorageSpecificationstring

Storage specification to select certain types of disks for the allocation during snapvolume creation like ctlr:c1 or mediatype:ssd etc.

Autogrowboolean

Specify false if the dedicated (non-shared) cache that is associated with a space-optimized snapshot should not be grown automatically when extra space is required.

Response

The request has succeeded.

detailstring

Error details.

statusinteger

http code

Changes

No recorded changes to this operation across all 1 revision of this API.