InstanceService

A set of methods for managing Instance resources.

Call	Description
Get	Returns the specified Instance resource.
List	Retrieves the list of Instance resources in the specified folder.
Create	Creates an instance in the specified folder.
Update	Updates the specified instance.
Delete	Deletes the specified instance.
UpdateMetadata	Updates the metadata of the specified instance.
GetSerialPortOutput	Returns the serial port output of the specified Instance resource.
Stop	Stops the running instance.
Start	Starts the stopped instance.
Restart	Restarts the running instance.
AttachDisk	Attaches the disk to the instance.
DetachDisk	Detaches the disk from the instance.
AddOneToOneNat	Enables One-to-one NAT on the network interface.
RemoveOneToOneNat	Removes One-to-one NAT from the network interface.
UpdateNetworkInterface	Updates the specified instance network interface.
ListOperations	Lists operations for the specified instance.

Calls InstanceService

Get

Returns the specified Instance resource.
To get the list of available Instance resources, make a List request.

rpc Get (GetInstanceRequest) returns (Instance)

GetInstanceRequest

Field	Description
instance_id	string Required. ID of the Instance resource to return. To get the instance ID, use a InstanceService.List request. The maximum string length in characters is 50.
view	enum InstanceView Defines which information about the Instance resource should be returned in the server response. BASIC: Doesn't include the metadata of the instance in the server response. FULL: Returns the metadata of the instance in the server response.

Instance

Field	Description
id	string ID of the instance.
folder_id	string ID of the folder that the instance belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id	string ID of the availability zone where the instance resides.
platform_id	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. PROVISIONING: Instance is waiting for resources to be allocated. RUNNING: Instance is running normally. STOPPING: Instance is being stopped. STOPPED: Instance stopped. STARTING: Instance is being started. RESTARTING: Instance is being restarted. UPDATING: Instance is being updated. ERROR: Instance encountered a problem and cannot operate. CRASHED: Instance crashed and will be restarted automatically. DELETING: Instance is being deleted.
metadata	map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk	AttachedDisk Boot disk that is attached to the instance.
secondary_disks[]	AttachedDisk Array of secondary disks that are attached to the instance.
network_interfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
fqdn	string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network Settings
placement_policy	PlacementPolicy Placement policy configuration.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
core_fraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. READ_ONLY: Read-only access. READ_WRITE: Read/Write access.
device_name	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id	string ID of the disk that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address	string MAC address that is assigned to the network interface.
subnet_id	string ID of the subnet.
primary_v4_address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address	PrimaryAddress Primary IPv6 address that is 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

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ip_version	enum IpVersion IP version for the external IP address. IPV4: IPv4 address, for example 192.0.2.235. IPV6: IPv6 address. Not available yet.
dns_records[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

List

Retrieves the list of Instance resources in the specified folder.

rpc List (ListInstancesRequest) returns (ListInstancesResponse)

ListInstancesRequest

Field	Description
folder_id	string Required. ID of the Folder to list instances in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListInstancesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListInstancesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string The field name. Currently you can use filtering only on the Instance.name field. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. The value. Must be 3-63 characters long and match the regular expression ^[a-z]([-a-z0-9]{,61}[a-z0-9])?$. The maximum string length in characters is 1000.

ListInstancesResponse

Field	Description
instances[]	Instance List of Instance resources.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListInstancesRequest.page_size, use the next_page_token as the value for the ListInstancesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Instance

Field	Description
id	string ID of the instance.
folder_id	string ID of the folder that the instance belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id	string ID of the availability zone where the instance resides.
platform_id	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. PROVISIONING: Instance is waiting for resources to be allocated. RUNNING: Instance is running normally. STOPPING: Instance is being stopped. STOPPED: Instance stopped. STARTING: Instance is being started. RESTARTING: Instance is being restarted. UPDATING: Instance is being updated. ERROR: Instance encountered a problem and cannot operate. CRASHED: Instance crashed and will be restarted automatically. DELETING: Instance is being deleted.
metadata	map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk	AttachedDisk Boot disk that is attached to the instance.
secondary_disks[]	AttachedDisk Array of secondary disks that are attached to the instance.
network_interfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
fqdn	string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network Settings
placement_policy	PlacementPolicy Placement policy configuration.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
core_fraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. READ_ONLY: Read-only access. READ_WRITE: Read/Write access.
device_name	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id	string ID of the disk that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address	string MAC address that is assigned to the network interface.
subnet_id	string ID of the subnet.
primary_v4_address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address	PrimaryAddress Primary IPv6 address that is 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

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ip_version	enum IpVersion IP version for the external IP address. IPV4: IPv4 address, for example 192.0.2.235. IPV6: IPv6 address. Not available yet.
dns_records[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

Create

Creates an instance in the specified folder. Method starts an asynchronous operation that can be cancelled while it is in progress.

rpc Create (CreateInstanceRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateInstanceMetadata

    Operation.response:Instance

CreateInstanceRequest

Field	Description
folder_id	string Required. ID of the folder to create an instance in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
name	string Name of the instance. Value must match the regular expression `
description	string Description of the instance. The maximum string length in characters is 256.
labels	map<string,string> Resource labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.
zone_id	string Required. ID of the availability zone where the instance resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request The maximum string length in characters is 50.
platform_id	string Required. ID of the hardware platform configuration for the instance. This field affects the available values in resources_spec field. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms.
resources_spec	ResourcesSpec Required. Computing resources of the instance, such as the amount of memory and number of cores. To get a list of available values, see Levels of core performance.
metadata	map<string,string> The metadata key:value pairs that will be assigned to this instance. This includes custom metadata and predefined keys. The total size of all keys and values must be less than 512 KB. Values are free-form strings, and only have meaning as interpreted by the programs which configure the instance. The values must be 256 KB or less. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk_spec	AttachedDiskSpec Required. Boot disk to attach to the instance.
secondary_disk_specs[]	AttachedDiskSpec Array of secondary disks to attach to the instance. The maximum number of elements is 3.
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 elemets must be exactly 1.
hostname	string Host name for the instance. This field is used to generate the yandex.cloud.compute.v1.Instance.fqdn value. The host name must be unique within the network and region. If not specified, the host name will be equal to yandex.cloud.compute.v1.Instance.id of the instance and FQDN will be <id>.auto.internal. Otherwise FQDN will be <hostname>.<region_id>.internal. Value must match the regular expression `
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network settings.
placement_policy	PlacementPolicy Placement policy configuration.

ResourcesSpec

Field	Description
memory	int64 Required. The amount of memory available to the instance, specified in bytes. The maximum value is 274877906944.
cores	int64 Required. The number of cores available to the instance. Value must be equal to 2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64,68,72,76,80.
core_fraction	int64 Value must be equal to 0,5,20,50,100.
gpus	int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4.

AttachedDiskSpec

Field	Description
mode	enum Mode The mode in which to attach this disk. READ_ONLY: Read-only access. READ_WRITE: Read/Write access. Default value.
device_name	string Specifies a unique serial number of your choice that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, a random value will be generated. Value must match the regular expression [a-z][a-z0-9-_]{,19}.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk	oneof: disk_spec or disk_id
disk_spec	DiskSpec Disk specification.
disk_id	string ID of the disk that should be attached. The maximum string length in characters is 50.

DiskSpec

Field	Description
name	string Name of the disk. Value must match the regular expression `
description	string Description of the disk. The maximum string length in characters is 256.
type_id	string ID of the disk type. To get a list of available disk types, use the yandex.cloud.compute.v1.DiskTypeService.List request. The maximum string length in characters is 50.
size	int64 Required. Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive.
block_size	int64 Block size of the disk, specified in bytes. The default is 4096.
disk_placement_policy	DiskPlacementPolicy Placement policy configuration.
source	oneof: image_id or snapshot_id
image_id	string ID of the image to create the disk from. The maximum string length in characters is 50.
snapshot_id	string ID of the snapshot to restore the disk from. The maximum string length in characters is 50.

NetworkInterfaceSpec

Field	Description
subnet_id	string Required. ID of the subnet. The maximum string length in characters is 50.
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
dns_record_specs[]	DnsRecordSpec External DNS configuration

DnsRecordSpec

Field	Description
fqdn	string Required. FQDN (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) Acceptable values are 0 to 86400, inclusive.
ptr	bool When set to true, also create PTR DNS record (optional)

DnsRecordSpec

Field	Description
fqdn	string Required. FQDN (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) Acceptable values are 0 to 86400, inclusive.
ptr	bool When set to true, also create PTR DNS record (optional)

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

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<CreateInstanceMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Instance> if operation finished successfully.

CreateInstanceMetadata

Field	Description
instance_id	string ID of the instance that is being created. The maximum string length in characters is 50.

Instance

Field	Description
id	string ID of the instance.
folder_id	string ID of the folder that the instance belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id	string ID of the availability zone where the instance resides.
platform_id	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. PROVISIONING: Instance is waiting for resources to be allocated. RUNNING: Instance is running normally. STOPPING: Instance is being stopped. STOPPED: Instance stopped. STARTING: Instance is being started. RESTARTING: Instance is being restarted. UPDATING: Instance is being updated. ERROR: Instance encountered a problem and cannot operate. CRASHED: Instance crashed and will be restarted automatically. DELETING: Instance is being deleted.
metadata	map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk	AttachedDisk Boot disk that is attached to the instance.
secondary_disks[]	AttachedDisk Array of secondary disks that are attached to the instance.
network_interfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
fqdn	string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network Settings
placement_policy	PlacementPolicy Placement policy configuration.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
core_fraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. READ_ONLY: Read-only access. READ_WRITE: Read/Write access.
device_name	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id	string ID of the disk that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address	string MAC address that is assigned to the network interface.
subnet_id	string ID of the subnet.
primary_v4_address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address	PrimaryAddress Primary IPv6 address that is 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

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ip_version	enum IpVersion IP version for the external IP address. IPV4: IPv4 address, for example 192.0.2.235. IPV6: IPv6 address. Not available yet.
dns_records[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

Update

Updates the specified instance.

rpc Update (UpdateInstanceRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateInstanceMetadata

    Operation.response:Instance

UpdateInstanceRequest

Field	Description
instance_id	string Required. ID of the Instance resource to update. To get the instance ID, use a InstanceService.List request. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the Instance resource are going to be updated.
name	string Name of the instance. Value must match the regular expression `
description	string Description of the instance. The maximum string length in characters is 256.
labels	map<string,string> Resource labels as key:value pairs. Existing set of labels is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\\@0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\\@0-9a-z]*.
platform_id	string ID of the hardware platform configuration for the instance. This field affects the available values in resources_spec field. Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms.
resources_spec	ResourcesSpec Computing resources of the instance, such as the amount of memory and number of cores. To get a list of available values, see Levels of core performance.
metadata	map<string,string> The metadata key:value pairs that will be assigned to this instance. This includes custom metadata and predefined keys. The total size of all keys and values must be less than 512 KB. Existing set of metadata is completely replaced by the provided set. Values are free-form strings, and only have meaning as interpreted by the programs which configure the instance. The values must be 256 KB or less. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network settings.
placement_policy	PlacementPolicy Placement policy configuration.

ResourcesSpec

Field	Description
memory	int64 Required. The amount of memory available to the instance, specified in bytes. The maximum value is 274877906944.
cores	int64 Required. The number of cores available to the instance. Value must be equal to 2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32,34,36,40,44,48,52,56,60,64,68,72,76,80.
core_fraction	int64 Value must be equal to 0,5,20,50,100.
gpus	int64 The number of GPUs available to the instance. Value must be equal to 0,1,2,4.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

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<UpdateInstanceMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Instance> if operation finished successfully.

UpdateInstanceMetadata

Field	Description
instance_id	string ID of the Instance resource that is being updated.

Instance

Field	Description
id	string ID of the instance.
folder_id	string ID of the folder that the instance belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id	string ID of the availability zone where the instance resides.
platform_id	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. PROVISIONING: Instance is waiting for resources to be allocated. RUNNING: Instance is running normally. STOPPING: Instance is being stopped. STOPPED: Instance stopped. STARTING: Instance is being started. RESTARTING: Instance is being restarted. UPDATING: Instance is being updated. ERROR: Instance encountered a problem and cannot operate. CRASHED: Instance crashed and will be restarted automatically. DELETING: Instance is being deleted.
metadata	map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk	AttachedDisk Boot disk that is attached to the instance.
secondary_disks[]	AttachedDisk Array of secondary disks that are attached to the instance.
network_interfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
fqdn	string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network Settings
placement_policy	PlacementPolicy Placement policy configuration.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
core_fraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. READ_ONLY: Read-only access. READ_WRITE: Read/Write access.
device_name	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id	string ID of the disk that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address	string MAC address that is assigned to the network interface.
subnet_id	string ID of the subnet.
primary_v4_address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address	PrimaryAddress Primary IPv6 address that is 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

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ip_version	enum IpVersion IP version for the external IP address. IPV4: IPv4 address, for example 192.0.2.235. IPV6: IPv6 address. Not available yet.
dns_records[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

Delete

Deletes the specified instance.

rpc Delete (DeleteInstanceRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteInstanceMetadata

    Operation.response:google.protobuf.Empty

DeleteInstanceRequest

Field	Description
instance_id	string Required. ID of the instance to delete. To get the instance ID, use a InstanceService.List request. The maximum string length in characters is 50.

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<DeleteInstanceMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteInstanceMetadata

Field	Description
instance_id	string ID of the instance that is being deleted.

UpdateMetadata

Updates the metadata of the specified instance.

rpc UpdateMetadata (UpdateInstanceMetadataRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateInstanceMetadataMetadata

    Operation.response:Instance

UpdateInstanceMetadataRequest

Field	Description
instance_id	string ID of the instance that is being updated.
delete[]	string List of keys to be deleted.
upsert	map<string,string> The metadata key:value pairs that will be added or updated to this instance.

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<UpdateInstanceMetadataMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Instance> if operation finished successfully.

UpdateInstanceMetadataMetadata

Field	Description
instance_id	string ID of the instance that is being updated.

Instance

Field	Description
id	string ID of the instance.
folder_id	string ID of the folder that the instance belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id	string ID of the availability zone where the instance resides.
platform_id	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. PROVISIONING: Instance is waiting for resources to be allocated. RUNNING: Instance is running normally. STOPPING: Instance is being stopped. STOPPED: Instance stopped. STARTING: Instance is being started. RESTARTING: Instance is being restarted. UPDATING: Instance is being updated. ERROR: Instance encountered a problem and cannot operate. CRASHED: Instance crashed and will be restarted automatically. DELETING: Instance is being deleted.
metadata	map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk	AttachedDisk Boot disk that is attached to the instance.
secondary_disks[]	AttachedDisk Array of secondary disks that are attached to the instance.
network_interfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
fqdn	string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network Settings
placement_policy	PlacementPolicy Placement policy configuration.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
core_fraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. READ_ONLY: Read-only access. READ_WRITE: Read/Write access.
device_name	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id	string ID of the disk that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address	string MAC address that is assigned to the network interface.
subnet_id	string ID of the subnet.
primary_v4_address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address	PrimaryAddress Primary IPv6 address that is 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

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ip_version	enum IpVersion IP version for the external IP address. IPV4: IPv4 address, for example 192.0.2.235. IPV6: IPv6 address. Not available yet.
dns_records[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

GetSerialPortOutput

Returns the serial port output of the specified Instance resource.

rpc GetSerialPortOutput (GetInstanceSerialPortOutputRequest) returns (GetInstanceSerialPortOutputResponse)

GetInstanceSerialPortOutputRequest

Field	Description
instance_id	string Required. ID of the instance to return the serial port output for. The maximum string length in characters is 50.
port	int64 Serial port to retrieve data from. The default is 1. Value must be equal to 1,2,3,4.

GetInstanceSerialPortOutputResponse

Field	Description
contents	string The contents of the serial port output, starting from the time when the instance started to boot.

Stop

Stops the running instance.
You can start the instance later using the InstanceService.Start method.

rpc Stop (StopInstanceRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StopInstanceMetadata

    Operation.response:google.protobuf.Empty

StopInstanceRequest

Field	Description
instance_id	string Required. ID of the instance to stop. To get the instance ID, use a InstanceService.List request. The maximum string length in characters is 50.

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<StopInstanceMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

StopInstanceMetadata

Field	Description
instance_id	string ID of the instance that is being deleted.

Start

Starts the stopped instance.

rpc Start (StartInstanceRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StartInstanceMetadata

    Operation.response:Instance

StartInstanceRequest

Field	Description
instance_id	string Required. ID of the instance to start. To get the instance ID, use a InstanceService.List request. The maximum string length in characters is 50.

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<StartInstanceMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Instance> if operation finished successfully.

StartInstanceMetadata

Field	Description
instance_id	string ID of the instance.

Instance

Field	Description
id	string ID of the instance.
folder_id	string ID of the folder that the instance belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id	string ID of the availability zone where the instance resides.
platform_id	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. PROVISIONING: Instance is waiting for resources to be allocated. RUNNING: Instance is running normally. STOPPING: Instance is being stopped. STOPPED: Instance stopped. STARTING: Instance is being started. RESTARTING: Instance is being restarted. UPDATING: Instance is being updated. ERROR: Instance encountered a problem and cannot operate. CRASHED: Instance crashed and will be restarted automatically. DELETING: Instance is being deleted.
metadata	map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk	AttachedDisk Boot disk that is attached to the instance.
secondary_disks[]	AttachedDisk Array of secondary disks that are attached to the instance.
network_interfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
fqdn	string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network Settings
placement_policy	PlacementPolicy Placement policy configuration.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
core_fraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. READ_ONLY: Read-only access. READ_WRITE: Read/Write access.
device_name	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id	string ID of the disk that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address	string MAC address that is assigned to the network interface.
subnet_id	string ID of the subnet.
primary_v4_address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address	PrimaryAddress Primary IPv6 address that is 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

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ip_version	enum IpVersion IP version for the external IP address. IPV4: IPv4 address, for example 192.0.2.235. IPV6: IPv6 address. Not available yet.
dns_records[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

Restart

Restarts the running instance.

rpc Restart (RestartInstanceRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RestartInstanceMetadata

    Operation.response:google.protobuf.Empty

RestartInstanceRequest

Field	Description
instance_id	string Required. ID of the instance to restart. To get the instance ID, use a InstanceService.List request. The maximum string length in characters is 50.

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<RestartInstanceMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

RestartInstanceMetadata

Field	Description
instance_id	string ID of the instance.

AttachDisk

Attaches the disk to the instance.

rpc AttachDisk (AttachInstanceDiskRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:AttachInstanceDiskMetadata

    Operation.response:Instance

AttachInstanceDiskRequest

Field	Description
instance_id	string Required. ID of the instance to attach the disk to. To get the instance ID, use a InstanceService.List request. The maximum string length in characters is 50.
attached_disk_spec	AttachedDiskSpec Required. Disk that should be attached.

AttachedDiskSpec

Field	Description
mode	enum Mode The mode in which to attach this disk. READ_ONLY: Read-only access. READ_WRITE: Read/Write access. Default value.
device_name	string Specifies a unique serial number of your choice that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, a random value will be generated. Value must match the regular expression [a-z][a-z0-9-_]{,19}.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk	oneof: disk_spec or disk_id
disk_spec	DiskSpec Disk specification.
disk_id	string ID of the disk that should be attached. The maximum string length in characters is 50.

DiskSpec

Field	Description
name	string Name of the disk. Value must match the regular expression `
description	string Description of the disk. The maximum string length in characters is 256.
type_id	string ID of the disk type. To get a list of available disk types, use the yandex.cloud.compute.v1.DiskTypeService.List request. The maximum string length in characters is 50.
size	int64 Required. Size of the disk, specified in bytes. Acceptable values are 4194304 to 4398046511104, inclusive.
block_size	int64 Block size of the disk, specified in bytes. The default is 4096.
disk_placement_policy	DiskPlacementPolicy Placement policy configuration.
source	oneof: image_id or snapshot_id
image_id	string ID of the image to create the disk from. The maximum string length in characters is 50.
snapshot_id	string ID of the snapshot to restore the disk from. The maximum string length in characters is 50.

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<AttachInstanceDiskMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Instance> if operation finished successfully.

AttachInstanceDiskMetadata

Field	Description
instance_id	string ID of the instance.
disk_id	string ID of the disk.

Instance

Field	Description
id	string ID of the instance.
folder_id	string ID of the folder that the instance belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id	string ID of the availability zone where the instance resides.
platform_id	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. PROVISIONING: Instance is waiting for resources to be allocated. RUNNING: Instance is running normally. STOPPING: Instance is being stopped. STOPPED: Instance stopped. STARTING: Instance is being started. RESTARTING: Instance is being restarted. UPDATING: Instance is being updated. ERROR: Instance encountered a problem and cannot operate. CRASHED: Instance crashed and will be restarted automatically. DELETING: Instance is being deleted.
metadata	map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk	AttachedDisk Boot disk that is attached to the instance.
secondary_disks[]	AttachedDisk Array of secondary disks that are attached to the instance.
network_interfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
fqdn	string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network Settings
placement_policy	PlacementPolicy Placement policy configuration.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
core_fraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. READ_ONLY: Read-only access. READ_WRITE: Read/Write access.
device_name	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id	string ID of the disk that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address	string MAC address that is assigned to the network interface.
subnet_id	string ID of the subnet.
primary_v4_address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address	PrimaryAddress Primary IPv6 address that is 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

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ip_version	enum IpVersion IP version for the external IP address. IPV4: IPv4 address, for example 192.0.2.235. IPV6: IPv6 address. Not available yet.
dns_records[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

DetachDisk

Detaches the disk from the instance.

rpc DetachDisk (DetachInstanceDiskRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DetachInstanceDiskMetadata

    Operation.response:Instance

DetachInstanceDiskRequest

Field	Description
instance_id	string Required. ID of the instance to detach the disk from. To get the instance ID, use a InstanceService.List request. The maximum string length in characters is 50.
disk	oneof: disk_id or device_name
disk_id	string ID of the disk that should be detached. The maximum string length in characters is 50.
device_name	string Serial number of the disk that should be detached. This value is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. Value must match the regular expression [a-z][a-z0-9-_]{,19}.

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<DetachInstanceDiskMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Instance> if operation finished successfully.

DetachInstanceDiskMetadata

Field	Description
instance_id	string ID of the instance.
disk_id	string ID of the disk.

Instance

Field	Description
id	string ID of the instance.
folder_id	string ID of the folder that the instance belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id	string ID of the availability zone where the instance resides.
platform_id	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. PROVISIONING: Instance is waiting for resources to be allocated. RUNNING: Instance is running normally. STOPPING: Instance is being stopped. STOPPED: Instance stopped. STARTING: Instance is being started. RESTARTING: Instance is being restarted. UPDATING: Instance is being updated. ERROR: Instance encountered a problem and cannot operate. CRASHED: Instance crashed and will be restarted automatically. DELETING: Instance is being deleted.
metadata	map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk	AttachedDisk Boot disk that is attached to the instance.
secondary_disks[]	AttachedDisk Array of secondary disks that are attached to the instance.
network_interfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
fqdn	string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network Settings
placement_policy	PlacementPolicy Placement policy configuration.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
core_fraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. READ_ONLY: Read-only access. READ_WRITE: Read/Write access.
device_name	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id	string ID of the disk that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address	string MAC address that is assigned to the network interface.
subnet_id	string ID of the subnet.
primary_v4_address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address	PrimaryAddress Primary IPv6 address that is 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

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ip_version	enum IpVersion IP version for the external IP address. IPV4: IPv4 address, for example 192.0.2.235. IPV6: IPv6 address. Not available yet.
dns_records[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

AddOneToOneNat

Enables One-to-one NAT on the network interface.

rpc AddOneToOneNat (AddInstanceOneToOneNatRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:AddInstanceOneToOneNatMetadata

    Operation.response:Instance

AddInstanceOneToOneNatRequest

Field	Description
instance_id	string ID of the instance to enable One-to-One NAT on.
network_interface_index	string The index of the network interface to enable One-to-One NAT on.
internal_address	string The network address that is assigned to the instance for this network interface.
one_to_one_nat_spec	OneToOneNatSpec An external IP address configuration. If not specified, then this instance will have no external internet access.

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
dns_record_specs[]	DnsRecordSpec External DNS configuration

DnsRecordSpec

Field	Description
fqdn	string Required. FQDN (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) Acceptable values are 0 to 86400, inclusive.
ptr	bool When set to true, also create PTR DNS record (optional)

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<AddInstanceOneToOneNatMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Instance> if operation finished successfully.

AddInstanceOneToOneNatMetadata

Field	Description
instance_id	string ID of the instance.

Instance

Field	Description
id	string ID of the instance.
folder_id	string ID of the folder that the instance belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id	string ID of the availability zone where the instance resides.
platform_id	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. PROVISIONING: Instance is waiting for resources to be allocated. RUNNING: Instance is running normally. STOPPING: Instance is being stopped. STOPPED: Instance stopped. STARTING: Instance is being started. RESTARTING: Instance is being restarted. UPDATING: Instance is being updated. ERROR: Instance encountered a problem and cannot operate. CRASHED: Instance crashed and will be restarted automatically. DELETING: Instance is being deleted.
metadata	map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk	AttachedDisk Boot disk that is attached to the instance.
secondary_disks[]	AttachedDisk Array of secondary disks that are attached to the instance.
network_interfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
fqdn	string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network Settings
placement_policy	PlacementPolicy Placement policy configuration.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
core_fraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. READ_ONLY: Read-only access. READ_WRITE: Read/Write access.
device_name	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id	string ID of the disk that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address	string MAC address that is assigned to the network interface.
subnet_id	string ID of the subnet.
primary_v4_address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address	PrimaryAddress Primary IPv6 address that is 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

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ip_version	enum IpVersion IP version for the external IP address. IPV4: IPv4 address, for example 192.0.2.235. IPV6: IPv6 address. Not available yet.
dns_records[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

RemoveOneToOneNat

Removes One-to-one NAT from the network interface.

rpc RemoveOneToOneNat (RemoveInstanceOneToOneNatRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RemoveInstanceOneToOneNatMetadata

    Operation.response:Instance

RemoveInstanceOneToOneNatRequest

Field	Description
instance_id	string ID of the instance to remove One-to-one NAT.
network_interface_index	string The index of the network interface to remove One-to-One NAT from.
internal_address	string The network address that is assigned to the instance for this network interface.

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<RemoveInstanceOneToOneNatMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Instance> if operation finished successfully.

RemoveInstanceOneToOneNatMetadata

Field	Description
instance_id	string ID of the instance.

Instance

Field	Description
id	string ID of the instance.
folder_id	string ID of the folder that the instance belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id	string ID of the availability zone where the instance resides.
platform_id	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. PROVISIONING: Instance is waiting for resources to be allocated. RUNNING: Instance is running normally. STOPPING: Instance is being stopped. STOPPED: Instance stopped. STARTING: Instance is being started. RESTARTING: Instance is being restarted. UPDATING: Instance is being updated. ERROR: Instance encountered a problem and cannot operate. CRASHED: Instance crashed and will be restarted automatically. DELETING: Instance is being deleted.
metadata	map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk	AttachedDisk Boot disk that is attached to the instance.
secondary_disks[]	AttachedDisk Array of secondary disks that are attached to the instance.
network_interfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
fqdn	string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network Settings
placement_policy	PlacementPolicy Placement policy configuration.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
core_fraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. READ_ONLY: Read-only access. READ_WRITE: Read/Write access.
device_name	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id	string ID of the disk that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address	string MAC address that is assigned to the network interface.
subnet_id	string ID of the subnet.
primary_v4_address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address	PrimaryAddress Primary IPv6 address that is 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

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ip_version	enum IpVersion IP version for the external IP address. IPV4: IPv4 address, for example 192.0.2.235. IPV6: IPv6 address. Not available yet.
dns_records[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

UpdateNetworkInterface

Updates the specified instance network interface.

rpc UpdateNetworkInterface (UpdateInstanceNetworkInterfaceRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateInstanceNetworkInterfaceMetadata

    Operation.response:Instance

UpdateInstanceNetworkInterfaceRequest

Field	Description
instance_id	string Required. ID of the network interface that is being updated.
network_interface_index	string Required. The index of the network interface to be updated.
update_mask	google.protobuf.FieldMask Field mask that specifies which attributes of the instance should be updated.
subnet_id	string ID of the subnet.
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
dns_record_specs[]	DnsRecordSpec External DNS configuration

DnsRecordSpec

Field	Description
fqdn	string Required. FQDN (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) Acceptable values are 0 to 86400, inclusive.
ptr	bool When set to true, also create PTR DNS record (optional)

DnsRecordSpec

Field	Description
fqdn	string Required. FQDN (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) Acceptable values are 0 to 86400, inclusive.
ptr	bool When set to true, also create PTR DNS record (optional)

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<UpdateInstanceNetworkInterfaceMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Instance> if operation finished successfully.

UpdateInstanceNetworkInterfaceMetadata

Field	Description
instance_id	string ID of the instant network interface that is being updated.
network_interface_index	string The index of the network interface.

Instance

Field	Description
id	string ID of the instance.
folder_id	string ID of the folder that the instance belongs to.
created_at	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	map<string,string> Resource labels as key:value pairs. Maximum of 64 per resource.
zone_id	string ID of the availability zone where the instance resides.
platform_id	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. PROVISIONING: Instance is waiting for resources to be allocated. RUNNING: Instance is running normally. STOPPING: Instance is being stopped. STOPPED: Instance stopped. STARTING: Instance is being started. RESTARTING: Instance is being restarted. UPDATING: Instance is being updated. ERROR: Instance encountered a problem and cannot operate. CRASHED: Instance crashed and will be restarted automatically. DELETING: Instance is being deleted.
metadata	map<string,string> The metadata key:value pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
boot_disk	AttachedDisk Boot disk that is attached to the instance.
secondary_disks[]	AttachedDisk Array of secondary disks that are attached to the instance.
network_interfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
fqdn	string A domain name of the instance. FQDN is defined by the server in the format <hostname>.<region_id>.internal when the instance is created. If the hostname were not specified when the instance was created, FQDN would be <id>.auto.internal.
scheduling_policy	SchedulingPolicy Scheduling policy configuration.
service_account_id	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
network_settings	NetworkSettings Network Settings
placement_policy	PlacementPolicy Placement policy configuration.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
core_fraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. READ_ONLY: Read-only access. READ_WRITE: Read/Write access.
device_name	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
auto_delete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
disk_id	string ID of the disk that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, generated by the server, 0,1,2... etc. Currently only one network interface is supported per instance.
mac_address	string MAC address that is assigned to the network interface.
subnet_id	string ID of the subnet.
primary_v4_address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primary_v6_address	PrimaryAddress Primary IPv6 address that is 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

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
one_to_one_nat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dns_records[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ip_version	enum IpVersion IP version for the external IP address. IPV4: IPv4 address, for example 192.0.2.235. IPV6: IPv6 address. Not available yet.
dns_records[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dns_zone_id	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SchedulingPolicy

Field	Description
preemptible	bool True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field	Description
type	enum Type Network Type STANDARD: Standard network. SOFTWARE_ACCELERATED: Software accelerated network. HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placement_group_id	string Placement group ID.
host_affinity_rules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

HostAffinityRule

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action
values[]	string Affinity value or host ID or host group ID

ListOperations

Lists operations for the specified instance.

rpc ListOperations (ListInstanceOperationsRequest) returns (ListInstanceOperationsResponse)

ListInstanceOperationsRequest

Field	Description
instance_id	string Required. ID of the Instance resource to list operations for. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListInstanceOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListInstanceOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListInstanceOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified instance.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListInstanceOperationsRequest.page_size, use the next_page_token as the value for the ListInstanceOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
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.