Snapshot

A set of methods for managing Snapshot resources.

JSON Representation

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "storageSize": "string",
  "diskSize": "string",
  "productIds": [
    "string"
  ],
  "status": "string",
  "sourceDiskId": "string"
}
Field Description
id string

ID of the snapshot.

folderId string

ID of the folder that the snapshot belongs to.

createdAt string (date-time)

String in RFC3339 text format.

name string

Name of the snapshot. 1-63 characters long.

description string

Description of the snapshot. 0-256 characters long.

labels object

Resource labels as key:value pairs. Maximum of 64 per resource.

storageSize string (int64)

Size of the snapshot, specified in bytes.

diskSize string (int64)

Size of the disk when the snapshot was created, specified in bytes.

productIds[] string

License IDs that indicate which licenses are attached to this resource. License IDs are used to calculate additional charges for the use of the virtual machine.

The correct license ID is generated by Yandex.Cloud. IDs are inherited by new resources created from this resource.

If you know the license IDs, specify them when you create the image. For example, if you create a disk image using a third-party utility and load it into Yandex Object Storage, the license IDs will be lost. You can specify them in the create request.

status string

Current status of the snapshot.

  • CREATING: Snapshot is being created.
  • READY: Snapshot is ready to use.
  • ERROR: Snapshot encountered a problem and cannot operate.
  • DELETING: Snapshot is being deleted.
sourceDiskId string

ID of the source disk used to create this snapshot.

Methods

Method Description
create Creates a snapshot of the specified disk.
delete Deletes the specified snapshot.
get Returns the specified Snapshot resource.
list Retrieves the list of Snapshot resources in the specified folder.
listOperations Lists operations for the specified snapshot.
update Updates the specified snapshot.