Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Compute Cloud
  • Yandex Container Solution
  • Access management
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • UpdateDisks
        • Disable
        • Enable
        • ListOperations
        • ListSnapshots
        • ListDisks
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
  • Monitoring metrics
  • Audit Trails events
  • Release notes

In this article:

  • gRPC request
  • ListSnapshotScheduleDisksRequest
  • ListSnapshotScheduleDisksResponse
  • Disk
  • DiskPlacementPolicy
  • HardwareGeneration
  • LegacyHardwareFeatures
  • Generation2HardwareFeatures
  • KMSKey
  1. API reference
  2. gRPC
  3. SnapshotSchedule
  4. ListDisks

Compute Cloud API, gRPC: SnapshotScheduleService.ListDisks

Written by
Yandex Cloud
Updated at December 17, 2024
  • gRPC request
  • ListSnapshotScheduleDisksRequest
  • ListSnapshotScheduleDisksResponse
  • Disk
  • DiskPlacementPolicy
  • HardwareGeneration
  • LegacyHardwareFeatures
  • Generation2HardwareFeatures
  • KMSKey

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

gRPC requestgRPC request

rpc ListDisks (ListSnapshotScheduleDisksRequest) returns (ListSnapshotScheduleDisksResponse)

ListSnapshotScheduleDisksRequestListSnapshotScheduleDisksRequest

{
  "snapshot_schedule_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

snapshot_schedule_id

string

ID of the snapshot schedule to list attached disks for.

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

page_size

int64

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

Default value: 100.

page_token

string

Page token. To get the next page of results, set page_token to the
ListSnapshotScheduleDisksResponse.next_page_token returned by a previous list request.

ListSnapshotScheduleDisksResponseListSnapshotScheduleDisksResponse

{
  "disks": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "map<string, string>",
      "type_id": "string",
      "zone_id": "string",
      "size": "int64",
      "block_size": "int64",
      "product_ids": [
        "string"
      ],
      "status": "Status",
      // Includes only one of the fields `source_image_id`, `source_snapshot_id`
      "source_image_id": "string",
      "source_snapshot_id": "string",
      // end of the list of possible fields
      "instance_ids": [
        "string"
      ],
      "disk_placement_policy": {
        "placement_group_id": "string",
        "placement_group_partition": "int64"
      },
      "hardware_generation": {
        // Includes only one of the fields `legacy_features`, `generation2_features`
        "legacy_features": {
          "pci_topology": "PCITopology"
        },
        "generation2_features": "Generation2HardwareFeatures"
        // end of the list of possible fields
      },
      "kms_key": {
        "key_id": "string",
        "version_id": "string"
      }
    }
  ],
  "next_page_token": "string"
}

Field

Description

disks[]

Disk

List of disks attached to the specified snapshot schedule.

next_page_token

string

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

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

DiskDisk

A Disk resource. For more information, see Disks.

Field

Description

id

string

ID of the disk.

folder_id

string

ID of the folder that the disk belongs to.

created_at

google.protobuf.Timestamp

name

string

Name of the disk. 1-63 characters long.

description

string

Description of the disk. 0-256 characters long.

labels

object (map<string, string>)

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

type_id

string

ID of the disk type.

zone_id

string

ID of the availability zone where the disk resides.

size

int64

Size of the disk, specified in bytes.

block_size

int64

Block size of the disk, specified in bytes.

product_ids[]

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 disk.

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

source_image_id

string

ID of the image that was used for disk creation.

Includes only one of the fields source_image_id, source_snapshot_id.

source_snapshot_id

string

ID of the snapshot that was used for disk creation.

Includes only one of the fields source_image_id, source_snapshot_id.

instance_ids[]

string

Array of instances to which the disk is attached.

disk_placement_policy

DiskPlacementPolicy

Placement policy configuration.

hardware_generation

HardwareGeneration

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

kms_key

KMSKey

Key encryption key info.

DiskPlacementPolicyDiskPlacementPolicy

Field

Description

placement_group_id

string

Placement group ID.

placement_group_partition

int64

HardwareGenerationHardwareGeneration

A set of features, specific to a particular Compute hardware generation.
They are not necessary supported by every host OS or distro, thus they are fixed to an image
and are applied to all instances created with it as their boot disk image.
These features significantly determine how the instance is created, thus cannot be changed after the fact.

Field

Description

legacy_features

LegacyHardwareFeatures

Includes only one of the fields legacy_features, generation2_features.

generation2_features

Generation2HardwareFeatures

Includes only one of the fields legacy_features, generation2_features.

LegacyHardwareFeaturesLegacyHardwareFeatures

A first hardware generation, by default compatible with all legacy images.
Allows switching to PCI_TOPOLOGY_V2 and back.

Field

Description

pci_topology

enum PCITopology

  • PCI_TOPOLOGY_UNSPECIFIED
  • PCI_TOPOLOGY_V1
  • PCI_TOPOLOGY_V2

Generation2HardwareFeaturesGeneration2HardwareFeatures

A second hardware generation, which by default assumes PCI_TOPOLOGY_V2
and UEFI boot (with UEFI related features).

Field

Description

Empty

KMSKeyKMSKey

Field

Description

key_id

string

ID of KMS symmetric key

version_id

string

Version of KMS symmetric key

Was the article helpful?

Previous
ListSnapshots
Next
ListAccessBindings
© 2025 Direct Cursus Technology L.L.C.