Compute Cloud API, REST: Disk.Get
Returns the specified Disk resource.
To get the list of available Disk resources, make a List request.
HTTP request
GET https://compute.api.cloud.yandex.net/compute/v1/disks/{diskId}
Path parameters
|
Field |
Description |
|
diskId |
string Required field. ID of the Disk resource to return. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"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"
}
}
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 To work with values in this field, use the APIs described in the |
|
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 |
|
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. 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. |
|
status |
enum (Status) Current status of the disk.
|
|
sourceImageId |
string ID of the image that was used for disk creation. Includes only one of the fields |
|
sourceSnapshotId |
string ID of the snapshot that was used for disk creation. Includes only one of the fields |
|
instanceIds[] |
string Array of instances to which the disk is attached. |
|
diskPlacementPolicy |
Placement policy configuration. |
|
hardwareGeneration |
If specified, forces the same HardwareGeneration features to be applied to the instance |
|
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 |
Includes only one of the fields |
|
generation2Features |
object Includes only one of the fields |
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)
|
KMSKey
|
Field |
Description |
|
keyId |
string ID of KMS symmetric key |
|
versionId |
string Version of KMS symmetric key |