Snapshots

Update a snapshot

Perform operations on a snapshot

patch/diskgroups/{DgId}/volumes/{VolId}/snapshots/{SnapId}

Request

Base URL
https://sort.veritas.com/infoscale/api/2.0
Auth
none declared
TypeScript
https://skmtc.dev/veritas/apis/veritas-infoscale-api/docs/diskgroups/:DgId/volumes/:VolId/snapshots/:SnapId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

DgIdstring required

Diskgroup identifier.

VolIdstring required

Name of the volume

SnapIdstring required

Name of the snapshot.

Query parameters

nodenamestring

If specified, snapshot operations will be performed from the specified node. In case of shared diskgroup it can be any node in the cluster. Else, a node where snapshot is created will be chosen internally. Error will be returned for a nodename specified which does not has the particular snapshot created.

Request body

SnapNamestring

Name of the snapshot

VolumeIdstring uri

Link to get more details of the snapshot volume

SourceVolstring uri

Link of associated parent volume (use "Null" keyword for dissociate PATCH operation)

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

Type of the snapshot like full-instant, space-optimized, mirror-breakoff etc.

SyncStatusstring

Percentage of data sync completed from source

CreatedAtstring

Timestamp when snapshot is taken (use "now" keyword to perform refresh PATCH operation)

Syncingboolean

Specify false if synchronization should not be started in case of refresh PATCH operation for full-sized instant snapshots.

Incompleteboolean

Specifies if the snapshot has not been fully synchronized with its parent volume.

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.