Compute Cloud API, REST: SnapshotSchedule.Get
Returns the specified snapshot schedule.
To get the list of available snapshot schedules, make a List request.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/snapshotSchedules/{snapshotScheduleId}
Path parameters
Field |
Description |
snapshotScheduleId |
string Required field. ID of the snapshot schedule to return. To get a schedule ID, make a SnapshotScheduleService.List request. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"status": "string",
"schedulePolicy": {
"startAt": "string",
"expression": "string"
},
// Includes only one of the fields `retentionPeriod`, `snapshotCount`
"retentionPeriod": "string",
"snapshotCount": "string",
// 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 |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
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 |
status |
enum (Status) Status of the snapshot schedule.
|
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 Includes only one of the fields 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 Includes only one of the fields Retention policy of the snapshot schedule. |
snapshotSpec |
Attributes of snapshots created by the snapshot schedule. |
SchedulePolicy
A resource for frequency settings of a snapshot schedule.
Field |
Description |
startAt |
string (date-time) Timestamp for creating the first snapshot. String in RFC3339 To work with values in this field, use the APIs described in the |
expression |
string Cron expression for the snapshot schedule (UTC+0). The expression must consist of five fields ( |
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 |