Compute Cloud API, REST: SnapshotSchedule.Create
Creates a snapshot schedule in the specified folder.
HTTP request
POST https://compute.api.cloud.yandex.net/compute/v1/snapshotSchedules
Body parameters
{
"folderId": "string",
"name": "string",
"description": "string",
"labels": "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"
},
"diskIds": [
"string"
]
}
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 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 |
string Snapshot schedule labels as |
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. |
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. |
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 |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"snapshotScheduleId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"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"
}
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
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 To work with values in this field, use the APIs described in the |
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 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
CreateSnapshotScheduleMetadata Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
CreateSnapshotScheduleMetadata
Field |
Description |
snapshotScheduleId |
string ID of the snapshot schedule that is being created. |
Status
The error result of the operation in case of failure or cancellation.
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. |
SnapshotSchedule
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 |