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
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Compute Cloud
  • Yandex Container Solution
  • Access management
  • Pricing policy
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • ListOperations
        • Move
        • Relocate
        • ListSnapshotSchedules
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
  • Monitoring metrics
  • Audit Trails events
  • Release notes

In this article:

  • gRPC request
  • RelocateDiskRequest
  • DiskPlacementPolicy
  • operation.Operation
  • RelocateDiskMetadata
  • Disk
  • DiskPlacementPolicy
  • HardwareGeneration
  • LegacyHardwareFeatures
  • Generation2HardwareFeatures
  • KMSKey
  1. API reference
  2. gRPC
  3. Disk
  4. Relocate

Compute Cloud API, gRPC: DiskService.Relocate

Written by
Yandex Cloud
Updated at December 17, 2024
  • gRPC request
  • RelocateDiskRequest
  • DiskPlacementPolicy
  • operation.Operation
  • RelocateDiskMetadata
  • Disk
  • DiskPlacementPolicy
  • HardwareGeneration
  • LegacyHardwareFeatures
  • Generation2HardwareFeatures
  • KMSKey

Moves the specified disk to another availability zone

Disk must be detached from instances. To move attached
disk use InstanceService.Relocate request.

gRPC requestgRPC request

rpc Relocate (RelocateDiskRequest) returns (operation.Operation)

RelocateDiskRequestRelocateDiskRequest

{
  "disk_id": "string",
  "destination_zone_id": "string",
  "disk_placement_policy": {
    "placement_group_id": "string",
    "placement_group_partition": "int64"
  }
}

Field

Description

disk_id

string

Required field. ID of the disk to move.

To get the disk ID, make a DiskService.List request.

destination_zone_id

string

Required field. ID of the availability zone to move the disk to.

To get the zone ID, make a ZoneService.List request.

disk_placement_policy

DiskPlacementPolicy

Placement policy configuration in target zone. Must be specified if disk has placement policy.

DiskPlacementPolicyDiskPlacementPolicy

Field

Description

placement_group_id

string

Placement group ID.

placement_group_partition

int64

operation.Operationoperation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "disk_id": "string",
    "source_zone_id": "string",
    "destination_zone_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "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"
    }
  }
  // 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.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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

RelocateDiskMetadata

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

google.rpc.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.

RelocateDiskMetadataRelocateDiskMetadata

Field

Description

disk_id

string

ID of the disk that is being moved.

source_zone_id

string

ID of the availability zone that the disk is being moved from.

destination_zone_id

string

ID of the availability zone that the disk is being moved to.

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
Move
Next
ListSnapshotSchedules
Yandex project
© 2025 Yandex.Cloud LLC