Метод list

Возвращает список доступных ресурсов Instance в указанном каталоге.

HTTP-запрос

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

Query-параметры

Параметр Описание
folderId Обязательное поле. Идентификатор каталога для получения списка виртуальных машин. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50.
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter Параметры фильтрации ресурсов в ответе. В параметрах фильтрации указываются: 1. Имя поля. В настоящее время фильтрация осуществляется только по полю Instance.name. 2. Оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений. 3. Значение. Должен содержать от 3 до 63 символов и соответствовать регулярному выражению ^[a-z]([-a-z0-9]{,61}[a-z0-9])?$. Максимальная длина строки в символах — 1000.

Ответ

HTTP Code: 200 - OK

{
  "instances": [
    {
      "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"
        }
      ],
      "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",
      "schedulingPolicy": {
        "preemptible": true
      },
      "serviceAccountId": "string",
      "networkSettings": {
        "type": "string"
      }
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
instances[] object

Ресурс Instance. Дополнительные сведения см. в разделе Виртуальные машины.

instances[].
id
string

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

instances[].
folderId
string

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

instances[].
createdAt
string (date-time)

Строка в формате RFC3339.

instances[].
name
string

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

instances[].
description
string

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

instances[].
labels
object

Метки ресурса в формате key:value. Максимум 64 на ресурс.

instances[].
zoneId
string

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

instances[].
platformId
string

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

instances[].
resources
object

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

instances[].
resources.
memory
string (int64)

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

instances[].
resources.
cores
string (int64)

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

instances[].
resources.
coreFraction
string (int64)

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

instances[].
resources.
gpus
string (int64)

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

instances[].
status
string

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

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

Метаданные в формате пар key:value, назначаемые данной виртуальной машине. Сюда входят пользовательские метаданные и предопределенные ключи.

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

instances[].
bootDisk
object

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

instances[].
bootDisk.
mode
string

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

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

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

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

instances[].
bootDisk.
autoDelete
boolean (boolean)

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

instances[].
bootDisk.
diskId
string

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

instances[].
secondaryDisks[]
object

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

instances[].
secondaryDisks[].
mode
string

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

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

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

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

instances[].
secondaryDisks[].
autoDelete
boolean (boolean)

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

instances[].
secondaryDisks[].
diskId
string

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

instances[].
networkInterfaces[]
object

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

instances[].
networkInterfaces[].
index
string

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

instances[].
networkInterfaces[].
macAddress
string

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

instances[].
networkInterfaces[].
subnetId
string

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

instances[].
networkInterfaces[].
primaryV4Address
object

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

instances[].
networkInterfaces[].
primaryV4Address.
address
string

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

instances[].
networkInterfaces[].
primaryV4Address.
oneToOneNat
object

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

instances[].
networkInterfaces[].
primaryV4Address.
oneToOneNat.
address
string

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

instances[].
networkInterfaces[].
primaryV4Address.
oneToOneNat.
ipVersion
string

Версия IP для публичного IP-адреса.

  • IPV4: IPv4-адрес, например 192.0.2.235.
  • IPV6: Адрес IPv6. На данный момент не доступен.
instances[].
networkInterfaces[].
primaryV6Address
object

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

instances[].
networkInterfaces[].
primaryV6Address.
address
string

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

instances[].
networkInterfaces[].
primaryV6Address.
oneToOneNat
object

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

instances[].
networkInterfaces[].
primaryV6Address.
oneToOneNat.
address
string

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

instances[].
networkInterfaces[].
primaryV6Address.
oneToOneNat.
ipVersion
string

Версия IP для публичного IP-адреса.

  • IPV4: IPv4-адрес, например 192.0.2.235.
  • IPV6: Адрес IPv6. На данный момент не доступен.
instances[].
fqdn
string

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

instances[].
schedulingPolicy
object

Конфигурация политики планирования.

instances[].
schedulingPolicy.
preemptible
boolean (boolean)

Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины.

instances[].
serviceAccountId
string

Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос list.

instances[].
networkSettings
object

Не указывайте это поле, сетевые настройки пока не поддерживаются.

instances[].
networkSettings.
type
string

Не указывайте это поле, сетевые настройки пока не поддерживаются.

  • STANDARD: Стандартная сеть.
  • SOFTWARE_ACCELERATED: Сеть с программным ускорением.
  • HARDWARE_ACCELERATED: Сеть с аппаратным ускорением (этот тип пока недоступен, значение зарезервировано для использования в будущем).
nextPageToken string

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.