Compute Cloud API, REST: SnapshotSchedule.listSnapshots
Retrieves the list of snapshots created by the specified snapshot schedule.
HTTP request
GET https://compute.api.il.nebius.cloud/compute/v1/snapshotSchedules/{snapshotScheduleId}/snapshots
Path parameters
| Parameter | Description |
|---|---|
| snapshotScheduleId | ID of the snapshot schedule to list created snapshots for. To get a snapshot schedule ID, make a list request. |
Query parameters
| Parameter | Description |
|---|---|
| pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. |
| pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. |
Response
HTTP Code: 200 - OK
{
"snapshots": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"storageSize": "string",
"diskSize": "string",
"productIds": [
"string"
],
"status": "string",
"sourceDiskId": "string"
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| snapshots[] | object List of snapshots created by the specified snapshot schedule. |
| snapshots[]. id |
string ID of the snapshot. |
| snapshots[]. folderId |
string ID of the folder that the snapshot belongs to. |
| snapshots[]. createdAt |
string (date-time) 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). |
| snapshots[]. name |
string Name of the snapshot. 1-63 characters long. |
| snapshots[]. description |
string Description of the snapshot. 0-256 characters long. |
| snapshots[]. labels |
object Resource labels as |
| snapshots[]. storageSize |
string (int64) Size of the snapshot, specified in bytes. |
| snapshots[]. diskSize |
string (int64) Size of the disk when the snapshot was created, specified in bytes. |
| snapshots[]. 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 create request. |
| snapshots[]. status |
string Current status of the snapshot.
|
| snapshots[]. sourceDiskId |
string ID of the source disk used to create this snapshot. |
| nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |