Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex Compute Cloud
  • Yandex Container Solution
  • Управление доступом
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • UpdateMetadata
        • GetSerialPortOutput
        • Stop
        • Start
        • Restart
        • AttachDisk
        • DetachDisk
        • AttachFilesystem
        • DetachFilesystem
        • AttachNetworkInterface
        • DetachNetworkInterface
        • AddOneToOneNat
        • RemoveOneToOneNat
        • UpdateNetworkInterface
        • ListOperations
        • Move
        • Relocate
        • SimulateMaintenanceEvent
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • История изменений
  • Обучающие курсы

В этой статье:

  • HTTP request
  • Path parameters
  • Query parameters
  • Response
  • Resources
  • MetadataOptions
  • AttachedDisk
  • AttachedLocalDisk
  • AttachedFilesystem
  • NetworkInterface
  • PrimaryAddress
  • OneToOneNat
  • DnsRecord
  • SerialPortSettings
  • GpuSettings
  • SchedulingPolicy
  • NetworkSettings
  • PlacementPolicy
  • HostAffinityRule
  • HardwareGeneration
  • LegacyHardwareFeatures
  1. Справочник API
  2. REST (англ.)
  3. Instance
  4. Get

Compute Cloud API, REST: Instance.Get

Статья создана
Yandex Cloud
Улучшена
Tania L.
Обновлена 21 февраля 2025 г.
  • HTTP request
  • Path parameters
  • Query parameters
  • Response
  • Resources
  • MetadataOptions
  • AttachedDisk
  • AttachedLocalDisk
  • AttachedFilesystem
  • NetworkInterface
  • PrimaryAddress
  • OneToOneNat
  • DnsRecord
  • SerialPortSettings
  • GpuSettings
  • SchedulingPolicy
  • NetworkSettings
  • PlacementPolicy
  • HostAffinityRule
  • HardwareGeneration
  • LegacyHardwareFeatures

Returns the specified Instance resource.

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

HTTP requestHTTP request

GET https://compute.api.cloud.yandex.net/compute/v1/instances/{instanceId}

Path parametersPath parameters

Field

Description

instanceId

string

Required field. ID of the Instance resource to return.
To get the instance ID, use a InstanceService.List request.

Query parametersQuery parameters

Field

Description

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.

ResponseResponse

HTTP Code: 200 - OK

{
  "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",
  "metadataOptions": {
    "gceHttpEndpoint": "string",
    "awsV1HttpEndpoint": "string",
    "gceHttpToken": "string",
    "awsV1HttpToken": "string"
  },
  "bootDisk": {
    "mode": "string",
    "deviceName": "string",
    "autoDelete": "boolean",
    "diskId": "string"
  },
  "secondaryDisks": [
    {
      "mode": "string",
      "deviceName": "string",
      "autoDelete": "boolean",
      "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": "boolean"
            }
          ]
        },
        "dnsRecords": [
          {
            "fqdn": "string",
            "dnsZoneId": "string",
            "ttl": "string",
            "ptr": "boolean"
          }
        ]
      },
      "primaryV6Address": {
        "address": "string",
        "oneToOneNat": {
          "address": "string",
          "ipVersion": "string",
          "dnsRecords": [
            {
              "fqdn": "string",
              "dnsZoneId": "string",
              "ttl": "string",
              "ptr": "boolean"
            }
          ]
        },
        "dnsRecords": [
          {
            "fqdn": "string",
            "dnsZoneId": "string",
            "ttl": "string",
            "ptr": "boolean"
          }
        ]
      },
      "securityGroupIds": [
        "string"
      ]
    }
  ],
  "serialPortSettings": {
    "sshAuthorization": "string"
  },
  "gpuSettings": {
    "gpuClusterId": "string"
  },
  "fqdn": "string",
  "schedulingPolicy": {
    "preemptible": "boolean"
  },
  "serviceAccountId": "string",
  "networkSettings": {
    "type": "string"
  },
  "placementPolicy": {
    "placementGroupId": "string",
    "hostAffinityRules": [
      {
        "key": "string",
        "op": "string",
        "values": [
          "string"
        ]
      }
    ],
    "placementGroupPartition": "string"
  },
  "hostGroupId": "string",
  "hostId": "string",
  "maintenancePolicy": "string",
  "maintenanceGracePeriod": "string",
  "hardwareGeneration": {
    // Includes only one of the fields `legacyFeatures`, `generation2Features`
    "legacyFeatures": {
      "pciTopology": "string"
    },
    "generation2Features": "object"
    // end of the list of possible fields
  },
  "reservedInstancePoolId": "string"
}

An Instance resource. For more information, see Instances.

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. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Name of the instance. 1-63 characters long.

description

string

Description of the instance. 0-256 characters long.

labels

object (map<string, string>)

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

Resources

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

status

enum (Status)

Status of the instance.

  • STATUS_UNSPECIFIED
  • 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 (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.

metadataOptions

MetadataOptions

Options allow user to configure access to instance's metadata

bootDisk

AttachedDisk

Boot disk that is attached to the instance.

secondaryDisks[]

AttachedDisk

Array of secondary disks that are attached to the instance.

localDisks[]

AttachedLocalDisk

Array of local disks that are attached to the instance.

filesystems[]

AttachedFilesystem

Array of filesystems that are attached to the instance.

networkInterfaces[]

NetworkInterface

Array of network interfaces that are attached to the instance.

serialPortSettings

SerialPortSettings

Serial port settings

gpuSettings

GpuSettings

GPU settings

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

SchedulingPolicy

Scheduling policy configuration.

serviceAccountId

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.

networkSettings

NetworkSettings

Network Settings

placementPolicy

PlacementPolicy

Placement policy configuration.

hostGroupId

string

ID of the dedicated host group that the instance belongs to.

hostId

string

ID of the dedicated host that the instance belongs to.

maintenancePolicy

enum (MaintenancePolicy)

Behaviour on maintenance events

  • MAINTENANCE_POLICY_UNSPECIFIED
  • RESTART: Restart instance to move it to another host during maintenance
  • MIGRATE: Use live migration to move instance to another host during maintenance

maintenanceGracePeriod

string (duration)

Time between notification via metadata service and maintenance

hardwareGeneration

HardwareGeneration

This feature set is inherited from the image/disk used as a boot one at the creation of the instance.

reservedInstancePoolId

string

ID of the reserved instance pool that the instance belongs to.

ResourcesResources

Field

Description

memory

string (int64)

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

cores

string (int64)

The number of cores available to the instance.

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.

gpus

string (int64)

The number of GPUs available to the instance.

MetadataOptionsMetadataOptions

Field

Description

gceHttpEndpoint

enum (MetadataOption)

Enabled access to GCE flavored metadata

  • METADATA_OPTION_UNSPECIFIED
  • ENABLED: Option is enabled
  • DISABLED: Option is disabled

awsV1HttpEndpoint

enum (MetadataOption)

Enabled access to AWS flavored metadata (IMDSv1)

  • METADATA_OPTION_UNSPECIFIED
  • ENABLED: Option is enabled
  • DISABLED: Option is disabled

gceHttpToken

enum (MetadataOption)

Enabled access to IAM credentials with GCE flavored metadata

  • METADATA_OPTION_UNSPECIFIED
  • ENABLED: Option is enabled
  • DISABLED: Option is disabled

awsV1HttpToken

enum (MetadataOption)

Enabled access to IAM credentials with AWS flavored metadata (IMDSv1)

  • METADATA_OPTION_UNSPECIFIED
  • ENABLED: Option is enabled
  • DISABLED: Option is disabled

AttachedDiskAttachedDisk

Field

Description

mode

enum (Mode)

Access mode to the Disk resource.

  • MODE_UNSPECIFIED
  • READ_ONLY: Read-only access.
  • READ_WRITE: Read/Write access.

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.

autoDelete

boolean

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

diskId

string

ID of the disk that is attached to the instance.

AttachedLocalDiskAttachedLocalDisk

Field

Description

size

string (int64)

Size of the disk, specified in bytes.

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.

AttachedFilesystemAttachedFilesystem

Field

Description

mode

enum (Mode)

Access mode to the filesystem.

  • MODE_UNSPECIFIED
  • READ_ONLY: Read-only access.
  • READ_WRITE: Read/Write access.

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.

filesystemId

string

ID of the filesystem that is attached to the instance.

NetworkInterfaceNetworkInterface

Field

Description

index

string

The index of the network interface, will be generated by the server, 0,1,2... etc if not specified.

macAddress

string

MAC address that is assigned to the network interface.

subnetId

string

ID of the subnet.

primaryV4Address

PrimaryAddress

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

primaryV6Address

PrimaryAddress

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

securityGroupIds[]

string

ID's of security groups attached to the interface

PrimaryAddressPrimaryAddress

Field

Description

address

string

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

oneToOneNat

OneToOneNat

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

dnsRecords[]

DnsRecord

Internal DNS configuration

OneToOneNatOneToOneNat

Field

Description

address

string

An external IP address associated with this instance.

ipVersion

enum (IpVersion)

IP version for the external IP address.

  • IP_VERSION_UNSPECIFIED
  • IPV4: IPv4 address, for example 192.0.2.235.
  • IPV6: IPv6 address. Not available yet.

dnsRecords[]

DnsRecord

External DNS configuration

DnsRecordDnsRecord

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).

dnsZoneId

string

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

ttl

string (int64)

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

ptr

boolean

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

SerialPortSettingsSerialPortSettings

Field

Description

sshAuthorization

enum (SSHAuthorization)

Authentication and authorization in serial console when using SSH protocol

  • SSH_AUTHORIZATION_UNSPECIFIED
  • INSTANCE_METADATA: Authentication and authorization using SSH keys in instance metadata
  • OS_LOGIN: Authentication and authorization using Oslogin service

GpuSettingsGpuSettings

Field

Description

gpuClusterId

string

Attach instance to specified GPU cluster.

SchedulingPolicySchedulingPolicy

Field

Description

preemptible

boolean

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

NetworkSettingsNetworkSettings

Field

Description

type

enum (Type)

Network Type

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

PlacementPolicyPlacementPolicy

Field

Description

placementGroupId

string

Placement group ID.

hostAffinityRules[]

HostAffinityRule

List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.

placementGroupPartition

string (int64)

Placement group partition

HostAffinityRuleHostAffinityRule

Affinity definition

Field

Description

key

string

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

op

enum (Operator)

Include or exclude action

  • OPERATOR_UNSPECIFIED
  • IN
  • NOT_IN

values[]

string

Affinity value or host ID or host group ID

HardwareGenerationHardwareGeneration

A set of features, specific to a particular Compute hardware generation.
They are not necessary supported by every host OS or distro, thus they are fixed to an image
and are applied to all instances created with it as their boot disk image.
These features significantly determine how the instance is created, thus cannot be changed after the fact.

Field

Description

legacyFeatures

LegacyHardwareFeatures

Includes only one of the fields legacyFeatures, generation2Features.

generation2Features

object

Includes only one of the fields legacyFeatures, generation2Features.

LegacyHardwareFeaturesLegacyHardwareFeatures

A first hardware generation, by default compatible with all legacy images.
Allows switching to PCI_TOPOLOGY_V2 and back.

Field

Description

pciTopology

enum (PCITopology)

  • PCI_TOPOLOGY_UNSPECIFIED
  • PCI_TOPOLOGY_V1
  • PCI_TOPOLOGY_V2

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

Предыдущая
Overview
Следующая
List
Проект Яндекса
© 2025 ООО «Яндекс.Облако»