Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Compute Cloud API, REST: DiskPlacementGroup.ListDisks

Written by
Updated at October 28, 2024

Lists disks for the specified placement group.

HTTP request

GET https://compute.api.cloud.yandex.net/compute/v1/diskPlacementGroups/{diskPlacementGroupId}/disks

Path parameters

Field

Description

diskPlacementGroupId

string

Required field. ID of the placement group to list disks for.
To get the placement group ID, use DiskPlacementGroupService.List request.

Query parameters

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 ListDiskPlacementGroupDisksResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

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

Response

HTTP Code: 200 - OK

{
  "disks": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "string",
      "typeId": "string",
      "zoneId": "string",
      "size": "string",
      "blockSize": "string",
      "productIds": [
        "string"
      ],
      "status": "string",
      // Includes only one of the fields `sourceImageId`, `sourceSnapshotId`
      "sourceImageId": "string",
      "sourceSnapshotId": "string",
      // end of the list of possible fields
      "instanceIds": [
        "string"
      ],
      "diskPlacementPolicy": {
        "placementGroupId": "string",
        "placementGroupPartition": "string"
      },
      "hardwareGeneration": {
        // Includes only one of the fields `legacyFeatures`, `generation2Features`
        "legacyFeatures": {
          "pciTopology": "string"
        },
        "generation2Features": "object"
        // end of the list of possible fields
      },
      "kmsKey": {
        "keyId": "string",
        "versionId": "string"
      }
    }
  ],
  "nextPageToken": "string"
}

Field

Description

disks[]

Disk

Lists disks for the specified placement group.

nextPageToken

string

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

Disk

A Disk resource. For more information, see Disks.

Field

Description

id

string

ID of the disk.

folderId

string

ID of the folder that the disk 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 disk. 1-63 characters long.

description

string

Description of the disk. 0-256 characters long.

labels

string

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

typeId

string

ID of the disk type.

zoneId

string

ID of the availability zone where the disk resides.

size

string (int64)

Size of the disk, specified in bytes.

blockSize

string (int64)

Block size of the disk, 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 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.

sourceImageId

string

ID of the image that was used for disk creation.

Includes only one of the fields sourceImageId, sourceSnapshotId.

sourceSnapshotId

string

ID of the snapshot that was used for disk creation.

Includes only one of the fields sourceImageId, sourceSnapshotId.

instanceIds[]

string

Array of instances to which the disk is attached.

diskPlacementPolicy

DiskPlacementPolicy

Placement policy configuration.

hardwareGeneration

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.

kmsKey

KMSKey

Key encryption key info.

DiskPlacementPolicy

Field

Description

placementGroupId

string

Placement group ID.

placementGroupPartition

string (int64)

HardwareGeneration

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

legacyFeatures

LegacyHardwareFeatures

Includes only one of the fields legacyFeatures, generation2Features.

generation2Features

object

Includes only one of the fields legacyFeatures, generation2Features.

LegacyHardwareFeatures

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

Field

Description

pciTopology

enum (PCITopology)

  • PCI_TOPOLOGY_UNSPECIFIED
  • PCI_TOPOLOGY_V1
  • PCI_TOPOLOGY_V2

KMSKey

Field

Description

keyId

string

ID of KMS symmetric key

versionId

string

Version of KMS symmetric key
Previous
Delete
Next
ListOperations