Метод get

Возвращает указанный ресурс Instance.

Чтобы получить список доступных ресурсов Instance, используйте запрос list .

HTTP-запрос

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

Path-параметры

Параметр Описание
instanceId Обязательное поле. Идентификатор возвращаемого ресурса Instance. Чтобы получить идентификатор виртуальной машины, используйте запрос list. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
view Определяет, какая информация о ресурсе Instance должна быть возвращена в ответе сервера.
  • BASIC: Не включает поле metadata в ответ сервера.
  • FULL: Возвращает в ответе сервера всю информацию о виртуальной машине, включая метаданные.

Ответ

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"
  },
  "status": "string",
  "metadata": "object",
  "bootDisk": {
    "mode": "string",
    "deviceName": "string",
    "autoDelete": true,
    "diskId": "string"
  },
  "secondaryDisks": [
    {
      "mode": "string",
      "deviceName": "string",
      "autoDelete": true,
      "diskId": "string"
    }
  ],
  "networkInterfaces": [
    {
      "index": "string",
      "macAddress": "string",
      "subnetId": "string",
      "primaryV4Address": {
        "address": "string",
        "oneToOneNat": {
          "address": "string",
          "ipVersion": "string"
        }
      },
      "primaryV6Address": {
        "address": "string",
        "oneToOneNat": {
          "address": "string",
          "ipVersion": "string"
        }
      }
    }
  ],
  "fqdn": "string"
}

Ресурс Instance. Подробнее см. Виртуальные машины.

Поле Описание
id string

Идентификатор виртуальной машины.

folderId string

Идентификатор каталога, которому принадлежит виртуальная машина.

createdAt string (date-time)

Время создания ресурса в формате в RFC3339.

name string

Имя виртуальной машины. Длина 1-63 символов.

description string

Описание виртуальной машины. Длина описания должна быть от 0 до 256 символов.

labels object

Метки ресурса в формате ключ:значение. Максимум 64 на ресурс.

zoneId string

Идентификатор зоны доступности, где находится виртуальная машина.

platformId string

Идентификатор аппаратной платформы виртуальной машины.

resources object

Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер.

resources.
memory
string (int64)

Объем памяти в байтах, доступный виртуальной машине.

resources.
cores
string (int64)

Количество ядер, доступных виртуальной машине.

resources.
coreFraction
string (int64)

Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра.

status string

Статус виртуальной машины.

  • PROVISIONING: Виртуальная машина ожидает выделения ресурсов.
  • RUNNING: Виртуальная машина работает нормально.
  • STOPPING: Виртуальная машина останавливается.
  • STOPPED: Виртуальная машина остановлена.
  • STARTING: Виртуальная машина запускается.
  • RESTARTING: Виртуальная машина перезапускается.
  • UPDATING: Виртуальная машина обновляется.
  • ERROR: С виртуальной машиной произошла ошибка, блокирующая работу.
  • CRASHED: Виртуальная машина аварийно завершила работу и будет перезапущена автоматически.
  • DELETING: Виртуальная машина удаляется.
metadata object

Метаданные, назначенные этой виртуальной машине, в формате пар ключ/значение. Это включает произвольные пользовательские метаданные и предзаданные ключи.

Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Подробнее см. Метаданные виртуальной машины.

bootDisk object

Загрузочный диск, подключенный к виртуальной машине.

Добавленные диски

bootDisk.
mode
string

Режим доступа к ресурсу Disk.

  • READ_ONLY: Доступ на чтение.
  • READ_WRITE: Доступ на чтение и запись.
bootDisk.
deviceName
string

Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/.

Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д.

bootDisk.
autoDelete
boolean (boolean)

Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины.

bootDisk.
diskId
string

Идентификатор диска, подключенного к виртуальной машине.

secondaryDisks[] object

Добавленные диски

secondaryDisks[].
mode
string

Режим доступа к ресурсу Disk.

  • READ_ONLY: Доступ на чтение.
  • READ_WRITE: Доступ на чтение и запись.
secondaryDisks[].
deviceName
string

Cерийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/.

Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д.

secondaryDisks[].
autoDelete
boolean (boolean)

Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины.

secondaryDisks[].
diskId
string

Идентификатор диска, подключенного к виртуальной машине.

networkInterfaces[] object

Массив сетевых интерфейсов, присоединенных к виртуальной машине.

networkInterfaces[].
index
string

Порядковый номер сетевого интерфейса, генерируемый сервером, 0,1,2... и так далее. В настоящее время поддерживается только один сетевой интерфейс для виртуальной машины.

networkInterfaces[].
macAddress
string

MAC-адрес, назначенный сетевому интерфейсу.

networkInterfaces[].
subnetId
string

Идентификатор подсети.

networkInterfaces[].
primaryV4Address
object

Primary IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса.

networkInterfaces[].
primaryV4Address.
address
string

Внутренний IPv4-адрес, назначенный виртуальной машине для этого сетевого интерфейса.

networkInterfaces[].
primaryV4Address.
oneToOneNat
object

Конфигурация One-to-one NAT. Если отсутствует, NAT не был настроен.

networkInterfaces[].
primaryV4Address.
oneToOneNat.
address
string

Внешний IP-адрес, связанный с этой виртуальной машиной.

networkInterfaces[].
primaryV4Address.
oneToOneNat.
ipVersion
string

Версия IP для внешнего IP-адреса.

  • IPV4: IPv4-адрес, например 192.0.2.235.
  • IPV6: IPv6-адрес, например, 2001:0db8:85a3:0000:0000:8a2e:0370:7334.
networkInterfaces[].
primaryV6Address
object

Primary IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен.

networkInterfaces[].
primaryV6Address.
address
string

Внутренний IPv4-адрес, назначенный виртуальной машине для этого сетевого интерфейса.

networkInterfaces[].
primaryV6Address.
oneToOneNat
object

Конфигурация One-to-one NAT. Если отсутствует, NAT не был настроен.

networkInterfaces[].
primaryV6Address.
oneToOneNat.
address
string

Внешний IP-адрес, связанный с этой виртуальной машиной.

networkInterfaces[].
primaryV6Address.
oneToOneNat.
ipVersion
string

Версия IP для внешнего IP-адреса.

  • IPV4: IPv4-адрес, например 192.0.2.235.
  • IPV6: IPv6-адрес, например, 2001:0db8:85a3:0000:0000:8a2e:0370:7334.
fqdn string

Доменное имя виртуальной машины. FQDN определяется сервером в формате <hostname>.<region_id>.internal при создании виртуальной машины. Если доменное имя не было определено при создании виртуальной машины, FQDN будет <id>.auto.internal.