Compute Cloud API, gRPC: DiskPlacementGroupService.ListDisks

Field

Description

disk_placement_group_id

string

Required field. ID of the placement group to list disks for.
To get the placement group ID, use DiskPlacementGroupService.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 ListDiskPlacementGroupDisksResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

page_token

string

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

Field

Description

disks[]

Disk

Lists disks for the specified placement group.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is more than ListDiskPlacementGroupDisksRequest.page_size, use
next_page_token as the value
for the ListDiskPlacementGroupDisksRequest.page_token query parameter
in the next list request. Each subsequent list request will have its own
next_page_token to continue paging through the results.

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.

Field

Description

placement_group_id

string

Placement group ID.

placement_group_partition

int64

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.

Field

Description

pci_topology

enum PCITopology

• PCI_TOPOLOGY_UNSPECIFIED
• PCI_TOPOLOGY_V1
• PCI_TOPOLOGY_V2

Field

Description

Empty

Field

Description

key_id

string

ID of KMS symmetric key

version_id

string

Version of KMS symmetric key