Compute Cloud API, REST: SnapshotSchedule methods
A set of methods for managing snapshot schedules.
JSON Representation
{
"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
}
| 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 A resource for frequency settings of a 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 A resource for 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, snapshotCountRetention 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, snapshotCountRetention 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. |
Methods
| Method | Description |
|---|---|
| create | Creates a snapshot schedule in the specified folder. |
| delete | Deletes the specified snapshot schedule. |
| disable | Disables the specified snapshot schedule. |
| enable | Enables the specified snapshot schedule. |
| get | Returns the specified snapshot schedule. |
| list | Retrieves the list of snapshot schedules in the specified folder. |
| listDisks | Retrieves the list of disks attached to the specified snapshot schedule. |
| listOperations | Lists operations for the specified snapshot schedule. |
| listSnapshots | Retrieves the list of snapshots created by the specified snapshot schedule. |
| update | Updates the specified snapshot schedule. |
| updateDisks | Updates the list of disks attached to the specified schedule. |