Compute Cloud API, gRPC: InstanceService.Relocate

Статья создана

Yandex Cloud

Улучшена

Tania L.

Обновлена 1 июня 2026 г.

gRPC request
RelocateInstanceRequest
NetworkInterfaceSpec
PrimaryAddressSpec
OneToOneNatSpec
DnsRecordSpec
DiskPlacementPolicy
DiskPlacementPolicyChange
operation.Operation

Moves the specified instance to another availability zone
Running instance will be restarted during this operation.

gRPC request

rpc Relocate (RelocateInstanceRequest) returns (operation.Operation)

RelocateInstanceRequest

{
  "instance_id": "string",
  "destination_zone_id": "string",
  "network_interface_specs": [
    {
      "index": "string",
      "subnet_id": "string",
      "primary_v4_address_spec": {
        "address": "string",
        "one_to_one_nat_spec": {
          "ip_version": "IpVersion",
          "address": "string",
          "dns_record_specs": [
            {
              "fqdn": "string",
              "dns_zone_id": "string",
              "ttl": "int64",
              "ptr": "bool"
            }
          ]
        },
        "dns_record_specs": [
          {
            "fqdn": "string",
            "dns_zone_id": "string",
            "ttl": "int64",
            "ptr": "bool"
          }
        ]
      },
      "primary_v6_address_spec": {
        "address": "string",
        "one_to_one_nat_spec": {
          "ip_version": "IpVersion",
          "address": "string",
          "dns_record_specs": [
            {
              "fqdn": "string",
              "dns_zone_id": "string",
              "ttl": "int64",
              "ptr": "bool"
            }
          ]
        },
        "dns_record_specs": [
          {
            "fqdn": "string",
            "dns_zone_id": "string",
            "ttl": "int64",
            "ptr": "bool"
          }
        ]
      },
      "security_group_ids": [
        "string"
      ]
    }
  ],
  "boot_disk_placement": {
    "placement_group_id": "string",
    "placement_group_partition": "int64"
  },
  "secondary_disk_placements": [
    {
      "disk_id": "string",
      "disk_placement_policy": {
        "placement_group_id": "string",
        "placement_group_partition": "int64"
      }
    }
  ]
}

Field	Description
instance_id	string ID of the instance to move. To get the instance ID, make a InstanceService.List request. The length must be less than or equal to 50. This field is required.
destination_zone_id	string ID of the availability zone to move the instance to. To get the zone ID, make a ZoneService.List request. The length must be less than or equal to 50. This field is required.
network_interface_specs[]	NetworkInterfaceSpec Network configuration for the instance. Specifies how the network interface is configured to interact with other services on the internal network and on the internet. Currently only one network interface is supported per instance. The number of elements must be exactly 1. This field is required.
boot_disk_placement	DiskPlacementPolicy Boot disk placement policy configuration in target zone. Must be specified if disk has placement policy.
secondary_disk_placements[]	DiskPlacementPolicyChange Secondary disk placement policy configurations in target zone. Must be specified for each disk that has placement policy.

NetworkInterfaceSpec

Field	Description
index	string The index of the network interface, will be generated by the server, 0,1,2... etc if not specified.
subnet_id	string ID of the subnet. The length must be less than or equal to 50. This field is required.
primary_v4_address_spec	PrimaryAddressSpec Primary IPv4 address that will be assigned to the instance for this network interface.
primary_v6_address_spec	PrimaryAddressSpec Primary IPv6 address that will be assigned to the instance for this network interface. IPv6 not available yet.
security_group_ids[]	string ID's of security groups attached to the interface

PrimaryAddressSpec

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
one_to_one_nat_spec	OneToOneNatSpec An external IP address configuration. If not specified, then this instance will have no external internet access.
dns_record_specs[]	DnsRecordSpec Internal DNS configuration

OneToOneNatSpec

Field	Description
ip_version	enum IpVersion External IP address version. `IPV4`: IPv4 address, for example 192.0.2.235. `IPV6`: IPv6 address. Not available yet.
address	string set static IP by value
dns_record_specs[]	DnsRecordSpec External DNS configuration

DnsRecordSpec

Field	Description
fqdn	string FQDN (required) This field is required.
dns_zone_id	string DNS zone id (optional, if not set, private zone used)
ttl	int64 DNS record ttl, values in 0-86400 (optional) The value must be between 0 and 86400.
ptr	bool When set to true, also create PTR DNS record (optional)

DiskPlacementPolicy

Field

Description

placement_group_id

string

Placement group ID.

placement_group_partition

int64

DiskPlacementPolicyChange

Field

Description

disk_id

string

Disk ID.

disk_placement_policy

DiskPlacementPolicy

Placement policy configuration for given disk.

operation.Operation

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

Compute Cloud API, gRPC: InstanceService.Relocate

gRPC requestgRPC request

RelocateInstanceRequestRelocateInstanceRequest

NetworkInterfaceSpecNetworkInterfaceSpec

PrimaryAddressSpecPrimaryAddressSpec

OneToOneNatSpecOneToOneNatSpec

DnsRecordSpecDnsRecordSpec

DiskPlacementPolicyDiskPlacementPolicy

DiskPlacementPolicyChangeDiskPlacementPolicyChange

operation.Operationoperation.Operation

Была ли статья полезна?