Compute Cloud API, REST: SnapshotSchedule.Delete
Deletes the specified snapshot schedule.
Deleting a snapshot schedule removes its data permanently and is irreversible. However, deleting a schedule
does not delete any snapshots created by the schedule. You must delete snapshots separately.
The schedule is deleted only after all snapshot creations and deletions triggered by the schedule are completed.
HTTP request
DELETE https://compute.api.cloud.yandex.net/compute/v1/snapshotSchedules/{snapshotScheduleId}
Path parameters
Field |
Description |
snapshotScheduleId |
string Required field. ID of the snapshot schedule to delete. To get a snapshot schedule ID, make a SnapshotScheduleService.List request. |
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`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
}
// 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 |
DeleteSnapshotScheduleMetadata 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. |
DeleteSnapshotScheduleMetadata
Field |
Description |
snapshotScheduleId |
string ID of the snapshot schedule that is being deleted. |
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. |