Compute Cloud API, REST: SnapshotSchedule.Create

Field

Description

folderId

string

ID of the folder to create a snapshot schedule in.
Snapshots are created in the same folder as the schedule, even if disks from other folders are attached
to the schedule.
To get a folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request.

name

string

Name of the snapshot schedule.
The name must be unique within the folder.

description

string

Description of the snapshot schedule.

labels

object (map<string, string>)

Snapshot schedule labels as key:value pairs.

schedulePolicy

SchedulePolicy

Frequency settings of the snapshot schedule.

retentionPeriod

string (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

string (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.

diskIds[]

string

List of IDs of the disks attached to the snapshot schedule.
To get a disk ID, make a yandex.cloud.compute.v1.DiskService.List request.

Field

Description

startAt

string (date-time)

Timestamp for creating the first snapshot.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

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

Field

Description

description

string

Description of the created snapshot.

labels

object (map<string, string>)

Snapshot labels as key:value pairs.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

object

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.