Compute Cloud API, REST: Disk.Update

Written by

Yandex Cloud

Improved by

amatol

Updated at January 14, 2025

HTTP request
Path parameters
Body parameters
DiskPlacementPolicy
Response
UpdateDiskMetadata
Status
Disk
DiskPlacementPolicy
HardwareGeneration
LegacyHardwareFeatures
KMSKey

Updates the specified disk.

HTTP request

PATCH https://compute.api.cloud.yandex.net/compute/v1/disks/{diskId}

Path parameters

Field

Description

diskId

string

Required field. ID of the Disk resource to update.
To get the disk ID use a DiskService.List request.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "size": "string",
  "diskPlacementPolicy": {
    "placementGroupId": "string",
    "placementGroupPartition": "string"
  }
}

Field	Description
updateMask	string (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string Name of the disk.
description	string Description of the disk.
labels	object (map<string, string>) Resource labels as `key:value` pairs. Existing set of `labels` is completely replaced by the provided set.
size	string (int64) Size of the disk, specified in bytes.
diskPlacementPolicy	DiskPlacementPolicy Placement policy configuration.

DiskPlacementPolicy

Field

Description

placementGroupId

string

Placement group ID.

placementGroupPartition

string (int64)

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "diskId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "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"
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. 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).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. 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).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	UpdateDiskMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Disk The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

UpdateDiskMetadata

Field

Description

diskId

string

ID of the Disk resource that is being updated.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

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	object (map<string, 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)

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

Compute Cloud API, REST: Disk.Update

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

DiskPlacementPolicyDiskPlacementPolicy

ResponseResponse

UpdateDiskMetadataUpdateDiskMetadata

StatusStatus

DiskDisk

DiskPlacementPolicyDiskPlacementPolicy

HardwareGenerationHardwareGeneration

LegacyHardwareFeaturesLegacyHardwareFeatures

KMSKeyKMSKey

Was the article helpful?

HTTP request

Path parameters

Body parameters

DiskPlacementPolicy

Response

UpdateDiskMetadata

Status

Disk

DiskPlacementPolicy

HardwareGeneration

LegacyHardwareFeatures

KMSKey