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
Parameter | Description |
---|---|
snapshotScheduleId | ID of the snapshot schedule to return. To get a schedule ID, make a list request. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string",
"schedulePolicy": {
"startAt": "string",
"expression": "string"
},
"snapshotSpec": {
"description": "string",
"labels": "object"
},
// includes only one of the fields `retentionPeriod`, `snapshotCount`
"retentionPeriod": "string",
"snapshotCount": "string",
// end of the list of possible fields
}
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 text format. The range of possible values is from 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). |
name | string Name of the snapshot schedule. The name is unique within the folder. |
description | string Description of the snapshot schedule. |
labels | object Snapshot schedule labels as |
status | string Status of the snapshot schedule.
|
schedulePolicy | object Frequency settings of the snapshot schedule. |
schedulePolicy. startAt |
string (date-time) Timestamp for creating the first snapshot. String in RFC3339 text format. The range of possible values is from 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). |
schedulePolicy. expression |
string Cron expression for the snapshot schedule (UTC+0). The expression must consist of five fields ( |
snapshotSpec | object Attributes of snapshots created by the snapshot schedule. |
snapshotSpec. description |
string Description of the created snapshot. |
snapshotSpec. labels |
object Snapshot labels as |
retentionPeriod | string includes only one of the fields retentionPeriod , snapshotCount Retention period of the snapshot schedule. Once a snapshot created by the schedule reaches this age, it is automatically deleted. |
snapshotCount | string (int64) includes only one of the fields retentionPeriod , snapshotCount 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. |