Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Compute Cloud API, gRPC: SnapshotScheduleService.Get

Written by
Updated at October 17, 2024

Returns the specified snapshot schedule.

To get the list of available snapshot schedules, make a List request.

gRPC request

rpc Get (GetSnapshotScheduleRequest) returns (SnapshotSchedule)

GetSnapshotScheduleRequest

{
  "snapshotScheduleId": "string"
}

Field

Description

snapshotScheduleId

string

ID of the snapshot schedule to return.

To get a schedule ID, make a SnapshotScheduleService.List request.

SnapshotSchedule

{
  "id": "string",
  "folderId": "string",
  "createdAt": "google.protobuf.Timestamp",
  "name": "string",
  "description": "string",
  "labels": "string",
  "status": "Status",
  "schedulePolicy": {
    "startAt": "google.protobuf.Timestamp",
    "expression": "string"
  },
  // Includes only one of the fields `retentionPeriod`, `snapshotCount`
  "retentionPeriod": "google.protobuf.Duration",
  "snapshotCount": "int64",
  // end of the list of possible fields
  "snapshotSpec": {
    "description": "string",
    "labels": "string"
  }
}

A snapshot schedule. For details about the concept, see documentation.

Field

Description

id

string

ID of the snapshot schedule.

folderId

string

ID of the folder that the snapshot schedule belongs to.

createdAt

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the snapshot schedule.

The name is unique within the folder.

description

string

Description of the snapshot schedule.

labels

string

Snapshot schedule labels as key:value pairs.

status

enum Status

Status of the snapshot schedule.

  • STATUS_UNSPECIFIED
  • CREATING: The snapshot schedule is being created.
  • ACTIVE: The snapshot schedule is on: new disk snapshots will be created, old ones deleted
    (if SnapshotSchedule.retentionPolicy is specified).
  • INACTIVE: The schedule is interrupted, snapshots won't be created or deleted.
  • DELETING: The schedule is being deleted.
  • UPDATING: Changes are being made to snapshot schedule settings or a list of attached disks.

schedulePolicy

SchedulePolicy

Frequency settings of the snapshot schedule.

retentionPeriod

google.protobuf.Duration

Retention period of the snapshot schedule. Once a snapshot created by the schedule reaches this age, it is
automatically deleted.

Includes only one of the fields retentionPeriod, snapshotCount.

Retention policy of the snapshot schedule.

snapshotCount

int64

Retention count of the snapshot schedule. Once the number of snapshots created by the schedule exceeds this
number, the oldest ones are automatically deleted. E.g. if the number is 5, the first snapshot is deleted
after the sixth one is created, the second is deleted after the seventh one is created, and so on.

Includes only one of the fields retentionPeriod, snapshotCount.

Retention policy of the snapshot schedule.

snapshotSpec

SnapshotSpec

Attributes of snapshots created by the snapshot schedule.

SchedulePolicy

A resource for frequency settings of a snapshot schedule.

Field

Description

startAt

google.protobuf.Timestamp

Timestamp for creating the first snapshot.

expression

string

Cron expression for the snapshot schedule (UTC+0).

The expression must consist of five fields (Minutes Hours Day-of-month Month Day-of-week) or be one of
nonstandard predefined expressions (e.g. @hourly). For details about the format,
see documentation

SnapshotSpec

A resource for attributes of snapshots created by the snapshot schedule.

Field

Description

description

string

Description of the created snapshot.

labels

string

Snapshot labels as key:value pairs.
Previous
Overview
Next
List