Nebius Israel
Contact usConsole
  • GPU
  • Docs
© 2023 Nebius Israel Ltd
Compute Cloud
  • Container Solution
  • Access management
  • Pricing policy
  1. API reference
  2. REST
  3. SnapshotSchedule
  4. listDisks

Compute Cloud API, REST: SnapshotSchedule.listDisks

  • HTTP request
  • Path parameters
  • Query parameters
  • Response

Retrieves the list of disks attached to the specified snapshot schedule.

HTTP requestHTTP request

GET https://compute.api.il.nebius.cloud/compute/v1/snapshotSchedules/{snapshotScheduleId}/disks

Path parametersPath parameters

Parameter Description
snapshotScheduleId

ID of the snapshot schedule to list attached disks for.

To get a snapshot schedule ID, make a list request.

Query parametersQuery 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.

ResponseResponse

HTTP Code: 200 - OK

{
  "disks": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "typeId": "string",
      "zoneId": "string",
      "size": "string",
      "blockSize": "string",
      "productIds": [
        "string"
      ],
      "status": "string",
      "instanceIds": [
        "string"
      ],
      "diskPlacementPolicy": {
        "placementGroupId": "string",
        "placementGroupPartition": "string"
      },

      // `disks[]` includes only one of the fields `sourceImageId`, `sourceSnapshotId`
      "sourceImageId": "string",
      "sourceSnapshotId": "string",
      // end of the list of possible fields`disks[]`

    }
  ],
  "nextPageToken": "string"
}
Field Description
disks[] object

List of disks attached to the specified snapshot schedule.

disks[].
id
string

ID of the disk.

disks[].
folderId
string

ID of the folder that the disk belongs to.

disks[].
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).

disks[].
name
string

Name of the disk. 1-63 characters long.

disks[].
description
string

Description of the disk. 0-256 characters long.

disks[].
labels
object

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

disks[].
typeId
string

ID of the disk type.

disks[].
zoneId
string

ID of the availability zone where the disk resides.

disks[].
size
string (int64)

Size of the disk, specified in bytes.

disks[].
blockSize
string (int64)

Block size of the disk, specified in bytes.

disks[].
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.

disks[].
status
string
Current status of the disk.
  • CREATING: Disk is being created.
  • READY: Disk is ready to use.
  • ERROR: Disk encountered a problem and cannot operate.
  • DELETING: Disk is being deleted.
disks[].
instanceIds[]
string

Array of instances to which the disk is attached.

disks[].
diskPlacementPolicy
object
Placement policy configuration.
disks[].
diskPlacementPolicy.
placementGroupId
string

Placement group ID.

disks[].
diskPlacementPolicy.
placementGroupPartition
string (int64)
disks[].
sourceImageId
string
disks[] includes only one of the fields sourceImageId, sourceSnapshotId

ID of the image that was used for disk creation.

disks[].
sourceSnapshotId
string
disks[] includes only one of the fields sourceImageId, sourceSnapshotId

ID of the snapshot that was used for disk creation.

nextPageToken string

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

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

© 2023 Nebius Israel Ltd
In this article:
  • HTTP request
  • Path parameters
  • Query parameters
  • Response