REST Resource: projects.locations.volumes.snapshots

Resource: VolumeSnapshot

A snapshot of a volume. Only boot volumes can have snapshots.

JSON representation
{
  "name": string,
  "id": string,
  "description": string,
  "createTime": string,
  "storageVolume": string,
  "type": enum (SnapshotType)
}
Fields
name

string

The name of the snapshot.

id

string

Output only. An identifier for the snapshot, generated by the backend.

description

string

The description of the snapshot.

createTime

string (Timestamp format)

Output only. The creation time of the snapshot.

storageVolume

string

Output only. The name of the volume which this snapshot belongs to.

type

enum (SnapshotType)

Output only. The type of the snapshot which indicates whether it was scheduled or manual/ad-hoc.

SnapshotType

Represents the type of a snapshot.

Enums
SNAPSHOT_TYPE_UNSPECIFIED Type is not specified.
AD_HOC Snapshot was taken manually by user.
SCHEDULED Snapshot was taken automatically as a part of a snapshot schedule.

Methods

create

Takes a snapshot of a boot volume.

delete

Deletes a volume snapshot.

get

Returns the specified snapshot resource.

list

Retrieves the list of snapshots for the specified volume.

restoreVolumeSnapshot

Uses the specified snapshot to restore its parent volume.