Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
© 2022 Yandex.Cloud LLC
Yandex Compute Cloud
  • Getting started
    • Overview
    • Creating a Linux VM
    • Creating a Windows VM
    • Creating instance groups
  • Step-by-step instructions
    • All instructions
    • Creating VMs
      • Creating a Linux VM
      • Creating a Windows VM
      • Creating a VM from a set of disks
      • Creating a VM with disks restored from snapshots
      • Creating a VM from a custom image
      • Creating a preemptible VM
      • Creating a VM with a GPU
    • DSVM
      • Overview
      • Creating a VM from a public DSVM image
    • Placement groups
      • Creating a placement group
      • Deleting a placement group
      • Creating a VM in a placement group
      • Adding a VM to a placement group
      • Removing a VM instance from a placement group
    • Images with pre-installed software
      • Creating a VM from a public image
      • Configuring software
      • Working with a VM based on a public image
      • Getting a list of public images
    • Getting information about a VM
      • Getting information about a VM
      • Getting serial port output
    • Managing VMs
      • Stopping and starting a VM
      • Attaching a disk to a VM
      • Detaching a disk from a VM
      • Moving a VM to a different availability zone
      • Moving a VM to another folder
      • Attaching a public IP address to a VM
      • Making a VM's public IP address static
      • Updating a VM
      • Changing VM computing resources
      • Deleting a VM
    • Working on VMs
      • Connecting to a VM via SSH
      • Connecting to a VM via RDP
      • Connecting to a VM via PowerShell
      • Working with Yandex Cloud from inside a VM
      • Installing NVIDIA drivers
      • Restoring access to a VM
    • Creating new disks
      • Creating an empty disk
      • Creating an empty disk with a large block
      • Creating a non-replicated disk
    • Disk management
      • Creating a disk snapshot
      • Updating a disk
      • Moving a disk to another folder
      • Deleting a disk
      • Deleting a disk snapshot
    • Disk placement groups
      • Creating a disk placement group
      • Removing a disk from a placement group
    • Creating new images
      • Preparing your disk image
      • Uploading your image
      • Creating an image from a disk
      • Creating an image from a snapshot
      • Creating an image from other custom image
    • Managing images
      • Deleting a disk image
    • File storage
      • Creating file storage
      • Attaching file storage to a VM
      • Detaching file storage from a VM
      • Updating file storage
      • Deleting file storage
    • Managing the serial console
      • Getting started
      • Connecting to a serial console via SSH
      • Connecting to a serial console via CLI
      • Start your terminal in the Windows SAC
      • Disabling access to the serial console
    • Creating instance groups
      • Creating a fixed-size instance group
      • Creating a fixed-size instance group with a network load balancer
      • Creating a fixed-size instance group with an L7 load balancer
      • Creating an automatically scaled instance group
      • Creating an instance group from a Container Optimized Image
      • Creating an instance group based on the YAML specification
    • Getting information about instance groups
      • Getting a list of instance groups
      • Getting information about an instance group
      • Getting a list of instances in a group
    • Managing instance groups
      • Editing an instance group
      • Editing an instance group based on the YAML specification
      • Configuring application health check on the VM
      • Updating a instance group
        • Incremental updates
        • Uninterrupted updates
      • Pausing an instance group
      • Resuming an instance group
      • Stopping an instance group
      • Starting an instance group
      • Deleting an instance group
    • Dedicated hosts
      • Creating a VM in a group of dedicated hosts
      • Creating a VM on a dedicated host
  • Yandex Container Optimized Solutions
  • Practical guidelines
    • Configuring NTP time synchronization
    • Running instance groups with auto scaling
    • Automatically scaling an instance group for handling messages from a queue
    • Updating an instance group under load
    • Deploying Remote Desktop Gateway
    • Transferring logs from a VM instance to Yandex Cloud Logging
  • Concepts
    • Relationship between resources
    • Virtual machines
      • Overview
      • Platforms
      • vCPU performance levels
      • Preemptible VMs
      • Network on a VM
      • Software-accelerated network
      • Live migration
      • Placement groups
      • Statuses
      • Metadata
    • Graphics accelerators (GPUs and vGPUs)
    • Disks and file storage
      • Overview
      • Disks
      • Disk snapshots
      • Non-replicated disk placement groups
      • File storage
      • Read and write operations
    • Images
    • Instance groups
      • Overview
      • Access
      • YAML specification
      • Instance template
      • Variables in an instance template
      • Policies
        • Overview
        • Allocation policy
        • Deployment policy
        • Scaling policy
      • Scaling types
      • Auto-healing
      • Updating
        • Overview
        • Allocating instances across zones
        • Deployment algorithm
        • Rules for updating instance groups
        • Changing secondary disks in an instance template
      • Stopping and pausing an instance group
      • Statuses
    • Dedicated host
    • Backups
    • Quotas and limits
  • Access management
  • Pricing policy
    • Current pricing policy
    • Archive
      • Before January 1, 2019
      • From January 1 to March 1, 2019
      • From March 1 to May 1, 2019
  • Compute API reference
    • Authentication in the API
    • gRPC
      • Overview
      • DiskPlacementGroupService
      • DiskService
      • DiskTypeService
      • FilesystemService
      • HostGroupService
      • HostTypeService
      • ImageService
      • InstanceService
      • PlacementGroupService
      • SnapshotService
      • ZoneService
      • InstanceGroupService
      • OperationService
    • REST
      • Overview
      • DiskPlacementGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listDisks
        • listOperations
        • update
      • Disk
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • move
        • update
      • DiskType
        • Overview
        • get
        • list
      • Filesystem
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • HostGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listHosts
        • listInstances
        • listOperations
        • update
      • HostType
        • Overview
        • get
        • list
      • Image
        • Overview
        • create
        • delete
        • get
        • getLatestByFamily
        • list
        • listOperations
        • update
      • Instance
        • Overview
        • addOneToOneNat
        • attachDisk
        • attachFilesystem
        • create
        • delete
        • detachDisk
        • detachFilesystem
        • get
        • getSerialPortOutput
        • list
        • listOperations
        • move
        • removeOneToOneNat
        • restart
        • start
        • stop
        • update
        • updateMetadata
        • updateNetworkInterface
      • PlacementGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listInstances
        • listOperations
        • update
      • Snapshot
        • Overview
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • Zone
        • Overview
        • get
        • list
      • Operation
        • Overview
        • get
      • InstanceGroup
        • Overview
        • list
        • get
        • listLogRecords
        • updateFromYaml
        • updateAccessBindings
        • pauseProcesses
        • stop
        • start
        • delete
        • listInstances
        • createFromYaml
        • update
        • setAccessBindings
        • listOperations
        • create
        • listAccessBindings
        • resumeProcesses
  • Questions and answers
    • General questions
    • Virtual machines
    • Connection
    • Disks, snapshots, and images
    • Monitoring
    • Licensing
    • All questions on the same page
  1. Compute API reference
  2. REST
  3. Instance
  4. Overview

Instance

Written by
Yandex.Cloud
,
improved by
amatol
  • JSON Representation
  • Methods

A set of methods for managing Instance resources.

JSON Representation

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "zoneId": "string",
  "platformId": "string",
  "resources": {
    "memory": "string",
    "cores": "string",
    "coreFraction": "string",
    "gpus": "string"
  },
  "status": "string",
  "metadata": "object",
  "bootDisk": {
    "mode": "string",
    "deviceName": "string",
    "autoDelete": true,
    "diskId": "string"
  },
  "secondaryDisks": [
    {
      "mode": "string",
      "deviceName": "string",
      "autoDelete": true,
      "diskId": "string"
    }
  ],
  "localDisks": [
    {
      "size": "string",
      "deviceName": "string"
    }
  ],
  "filesystems": [
    {
      "mode": "string",
      "deviceName": "string",
      "filesystemId": "string"
    }
  ],
  "networkInterfaces": [
    {
      "index": "string",
      "macAddress": "string",
      "subnetId": "string",
      "primaryV4Address": {
        "address": "string",
        "oneToOneNat": {
          "address": "string",
          "ipVersion": "string",
          "dnsRecords": [
            {
              "fqdn": "string",
              "dnsZoneId": "string",
              "ttl": "string",
              "ptr": true
            }
          ]
        },
        "dnsRecords": [
          {
            "fqdn": "string",
            "dnsZoneId": "string",
            "ttl": "string",
            "ptr": true
          }
        ]
      },
      "primaryV6Address": {
        "address": "string",
        "oneToOneNat": {
          "address": "string",
          "ipVersion": "string",
          "dnsRecords": [
            {
              "fqdn": "string",
              "dnsZoneId": "string",
              "ttl": "string",
              "ptr": true
            }
          ]
        },
        "dnsRecords": [
          {
            "fqdn": "string",
            "dnsZoneId": "string",
            "ttl": "string",
            "ptr": true
          }
        ]
      },
      "securityGroupIds": [
        "string"
      ]
    }
  ],
  "fqdn": "string",
  "schedulingPolicy": {
    "preemptible": true
  },
  "serviceAccountId": "string",
  "networkSettings": {
    "type": "string"
  },
  "placementPolicy": {
    "placementGroupId": "string",
    "hostAffinityRules": [
      {
        "key": "string",
        "op": "string",
        "values": [
          "string"
        ]
      }
    ]
  }
}
Field Description
id string

ID of the instance.

folderId string

ID of the folder that the instance belongs to.

createdAt string (date-time)

String in RFC3339 text format.

name string

Name of the instance. 1-63 characters long.

description string

Description of the instance. 0-256 characters long.

labels object

Resource labels as key:value pairs. Maximum of 64 per resource.

zoneId string

ID of the availability zone where the instance resides.

platformId string

ID of the hardware platform configuration for the instance.

resources object

Computing resources of the instance such as the amount of memory and number of cores.

resources.
memory
string (int64)

The amount of memory available to the instance, specified in bytes.

resources.
cores
string (int64)

The number of cores available to the instance.

resources.
coreFraction
string (int64)

Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.

resources.
gpus
string (int64)

The number of GPUs available to the instance.

status string

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 object

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.

bootDisk object

Boot disk that is attached to the instance.

bootDisk.
mode
string

Access mode to the Disk resource.

  • READ_ONLY: Read-only access.
  • READ_WRITE: Read/Write access.
bootDisk.
deviceName
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.

bootDisk.
autoDelete
boolean (boolean)

Specifies whether the disk will be auto-deleted when the instance is deleted.

bootDisk.
diskId
string

ID of the disk that is attached to the instance.

secondaryDisks[] object

Array of secondary disks that are attached to the instance.

secondaryDisks[].
mode
string

Access mode to the Disk resource.

  • READ_ONLY: Read-only access.
  • READ_WRITE: Read/Write access.
secondaryDisks[].
deviceName
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.

secondaryDisks[].
autoDelete
boolean (boolean)

Specifies whether the disk will be auto-deleted when the instance is deleted.

secondaryDisks[].
diskId
string

ID of the disk that is attached to the instance.

localDisks[] object

Array of local disks that are attached to the instance.

localDisks[].
size
string (int64)

Size of the disk, specified in bytes.

localDisks[].
deviceName
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.

filesystems[] object

Array of filesystems that are attached to the instance.

filesystems[].
mode
string

Access mode to the filesystem.

  • READ_ONLY: Read-only access.
  • READ_WRITE: Read/Write access.
filesystems[].
deviceName
string

Name of the device representing the filesystem on the instance.

The name should be used for referencing the filesystem from within the instance when it's being mounted, resized etc.

filesystems[].
filesystemId
string

ID of the filesystem that is attached to the instance.

networkInterfaces[] object

Array of network interfaces that are attached to the instance.

networkInterfaces[].
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.

networkInterfaces[].
macAddress
string

MAC address that is assigned to the network interface.

networkInterfaces[].
subnetId
string

ID of the subnet.

networkInterfaces[].
primaryV4Address
object

Primary IPv4 address that is assigned to the instance for this network interface.

networkInterfaces[].
primaryV4Address.
address
string

An IPv4 internal network address that is assigned to the instance for this network interface.

networkInterfaces[].
primaryV4Address.
oneToOneNat
object

One-to-one NAT configuration. If missing, NAT has not been set up.

networkInterfaces[].
primaryV4Address.
oneToOneNat.
address
string

An external IP address associated with this instance.

networkInterfaces[].
primaryV4Address.
oneToOneNat.
ipVersion
string

IP version for the external IP address.

  • IPV4: IPv4 address, for example 192.0.2.235.
  • IPV6: IPv6 address. Not available yet.
networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[]
object

External DNS configuration

networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[].
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).

networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[].
dnsZoneId
string

DNS zone id for the record (optional, if not set, some private zone is used).

networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[].
ttl
string (int64)

DNS record ttl (optional, if not set, a reasonable default is used.)

networkInterfaces[].
primaryV4Address.
oneToOneNat.
dnsRecords[].
ptr
boolean (boolean)

When true, indicates there is a corresponding auto-created PTR DNS record.

networkInterfaces[].
primaryV4Address.
dnsRecords[]
object

Internal DNS configuration

networkInterfaces[].
primaryV4Address.
dnsRecords[].
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).

networkInterfaces[].
primaryV4Address.
dnsRecords[].
dnsZoneId
string

DNS zone id for the record (optional, if not set, some private zone is used).

networkInterfaces[].
primaryV4Address.
dnsRecords[].
ttl
string (int64)

DNS record ttl (optional, if not set, a reasonable default is used.)

networkInterfaces[].
primaryV4Address.
dnsRecords[].
ptr
boolean (boolean)

When true, indicates there is a corresponding auto-created PTR DNS record.

networkInterfaces[].
primaryV6Address
object

Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet.

networkInterfaces[].
primaryV6Address.
address
string

An IPv4 internal network address that is assigned to the instance for this network interface.

networkInterfaces[].
primaryV6Address.
oneToOneNat
object

One-to-one NAT configuration. If missing, NAT has not been set up.

networkInterfaces[].
primaryV6Address.
oneToOneNat.
address
string

An external IP address associated with this instance.

networkInterfaces[].
primaryV6Address.
oneToOneNat.
ipVersion
string

IP version for the external IP address.

  • IPV4: IPv4 address, for example 192.0.2.235.
  • IPV6: IPv6 address. Not available yet.
networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[]
object

External DNS configuration

networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[].
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).

networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[].
dnsZoneId
string

DNS zone id for the record (optional, if not set, some private zone is used).

networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[].
ttl
string (int64)

DNS record ttl (optional, if not set, a reasonable default is used.)

networkInterfaces[].
primaryV6Address.
oneToOneNat.
dnsRecords[].
ptr
boolean (boolean)

When true, indicates there is a corresponding auto-created PTR DNS record.

networkInterfaces[].
primaryV6Address.
dnsRecords[]
object

Internal DNS configuration

networkInterfaces[].
primaryV6Address.
dnsRecords[].
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).

networkInterfaces[].
primaryV6Address.
dnsRecords[].
dnsZoneId
string

DNS zone id for the record (optional, if not set, some private zone is used).

networkInterfaces[].
primaryV6Address.
dnsRecords[].
ttl
string (int64)

DNS record ttl (optional, if not set, a reasonable default is used.)

networkInterfaces[].
primaryV6Address.
dnsRecords[].
ptr
boolean (boolean)

When true, indicates there is a corresponding auto-created PTR DNS record.

networkInterfaces[].
securityGroupIds[]
string

ID's of security groups attached to the interface

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.

schedulingPolicy object

Scheduling policy configuration.

schedulingPolicy.
preemptible
boolean (boolean)

True for short-lived compute instances. For more information, see Preemptible VMs.

serviceAccountId string

ID of the service account to use for authentication inside the instance. To get the service account ID, use a list request.

networkSettings object

Network Settings

networkSettings.
type
string

Network Type

  • STANDARD: Standard network.
  • SOFTWARE_ACCELERATED: Software accelerated network.
  • HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).
placementPolicy object

Placement policy configuration.

placementPolicy.
placementGroupId
string

Placement group ID.

placementPolicy.
hostAffinityRules[]
object

Affinitity definition

placementPolicy.
hostAffinityRules[].
key
string

Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'

placementPolicy.
hostAffinityRules[].
op
string

Include or exclude action

placementPolicy.
hostAffinityRules[].
values[]
string

Affinity value or host ID or host group ID

Methods

Method Description
addOneToOneNat Enables One-to-one NAT on the network interface.
attachDisk Attaches the disk to the instance.
attachFilesystem Attaches the filesystem to the instance.
create Creates an instance in the specified folder. Method starts an asynchronous operation that can be cancelled while it is in progress.
delete Deletes the specified instance.
detachDisk Detaches the disk from the instance.
detachFilesystem Detaches the filesystem from the instance.
get Returns the specified Instance resource.
getSerialPortOutput Returns the serial port output of the specified Instance resource.
list Retrieves the list of Instance resources in the specified folder.
listOperations Lists operations for the specified instance.
move Moves the specified instance to another folder of the same cloud.
removeOneToOneNat Removes One-to-one NAT from the network interface.
restart Restarts the running instance.
start Starts the stopped instance.
stop Stops the running instance.
update Updates the specified instance.
updateMetadata Updates the metadata of the specified instance.
updateNetworkInterface Updates the specified instance network interface.

Was the article helpful?

Language / Region
© 2022 Yandex.Cloud LLC
In this article:
  • JSON Representation
  • Methods