Compute Cloud API, REST: SnapshotSchedule.ListSnapshots

Field

Description

snapshotScheduleId

string

Required field. ID of the snapshot schedule to list created snapshots for.

To get a snapshot schedule ID, make a SnapshotScheduleService.List request.

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListSnapshotScheduleOperationsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

Default value: 100.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListSnapshotScheduleOperationsResponse.nextPageToken returned by a previous list request.

Field

Description

snapshots[]

Snapshot

List of snapshots created by the specified snapshot schedule.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListSnapshotScheduleSnapshotsRequest.pageSize, use next_page_token as the value
for the ListSnapshotScheduleSnapshotsRequest.pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

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. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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. 1-63 characters long.

description

string

Description of the snapshot. 0-256 characters long.

labels

string

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 the platform. 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 Object Storage, the license IDs will be lost.
You can specify them in the yandex.cloud.compute.v1.ImageService.Create request.

status

enum (Status)

Current status of the snapshot.

• STATUS_UNSPECIFIED
• 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.

hardwareGeneration

HardwareGeneration

If specified, forces the same HardwareGeneration features to be applied to the instance
created using this snapshot as source for the boot disk. Otherwise the current default will be used.

kmsKey

KMSKey

Key encryption key info.

Field

Description

legacyFeatures

LegacyHardwareFeatures

Includes only one of the fields legacyFeatures, generation2Features.

generation2Features

object

Includes only one of the fields legacyFeatures, generation2Features.

Field

Description

pciTopology

enum (PCITopology)

• PCI_TOPOLOGY_UNSPECIFIED
• PCI_TOPOLOGY_V1
• PCI_TOPOLOGY_V2

Field

Description

keyId

string

ID of KMS symmetric key

versionId

string

Version of KMS symmetric key