Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Compute Cloud
  • Начало работы
    • Обзор
    • Создание виртуальной машины Linux
    • Создание виртуальной машины Windows
    • Создание группы виртуальных машин
  • Пошаговые инструкции
    • Все инструкции
    • Создание виртуальной машины
      • Создать ВМ Linux
      • Создать ВМ Windows
      • Создать ВМ из набора дисков
      • Создать ВМ с дисками из снимков
      • Создать ВМ из пользовательского образа
      • Создать прерываемую ВМ
      • Создать ВМ c GPU
    • DSVM
      • Обзор
      • Создать ВМ из публичного образа DSVM
    • Группы размещения
      • Создать группу размещения
      • Удалить группу размещения
      • Создать ВМ в группе размещения
      • Добавить ВМ в группу размещения
      • Исключить ВМ из группы размещения
    • Образы с предустановленным ПО
      • Создать ВМ из публичного образа
      • Настроить ПО
      • Работа с ВМ на базе публичного образа
      • Получить список публичных образов
    • Получение информации о виртуальной машине
      • Получить информацию о ВМ
      • Получить вывод последовательного порта
    • Управление виртуальной машиной
      • Остановить и запустить ВМ
      • Подключить диск к ВМ
      • Отключить диск от ВМ
      • Перенести ВМ в другую зону доступности
      • Сделать публичный IP-адрес ВМ статическим
      • Изменить ВМ
      • Изменить вычислительные ресурсы ВМ
      • Удалить ВМ
    • Работа на виртуальной машине
      • Подключиться к ВМ по SSH
      • Подключиться к ВМ по RDP
      • Работа с Yandex.Cloud изнутри ВМ
      • Установить NVIDIA-драйверы
    • Создание нового диска
      • Создать пустой диcк
      • Создать пустой диск с блоком большого размера
    • Управление диском
      • Создать снимок диска
      • Изменить диск
      • Удалить диcк
      • Удалить снимок диска
    • Создание нового образа
      • Загрузить свой образ
    • Управление образом
      • Удалить образ
    • Управление серийной консолью
      • Начало работы
      • Подключиться к серийной консоли по SSH
      • Подключиться к серийной консоли с помощью CLI
      • Запустить командную оболочку в Windows SAC
      • Отключить доступ к серийной консоли
    • Создание группы виртуальных машин
      • Создать группу ВМ фиксированного размера
      • Создать группу ВМ фиксированного размера с сетевым балансировщиком
      • Создать автоматически масштабируемую группу ВМ
      • Создать группу ВМ с Container Optimized Image
    • Получение информации о группе виртуальных машин
      • Получить список групп ВМ
      • Получить информацию о группе ВМ
      • Получить список ВМ в группе
    • Управление группой виртуальных машин
      • Изменить группу ВМ
      • Настроить проверку состояния приложения на ВМ
      • Обновить группу
        • Постепенное обновление
        • Обновление без простоя
      • Остановить группу ВМ
      • Запустить группу ВМ
      • Удалить группу ВМ
    • Выделенные хосты
      • Создать ВМ в группе выделенных хостов
      • Создать ВМ на выделенном хосте
  • Yandex Container Solution
  • Сценарии использования
    • Настройка синхронизации времени NTP
    • Работа с группой ВМ с автоматическим масштабированием
  • Концепции
    • Взаимосвязь ресурсов
    • Виртуальные машины
      • Обзор
      • Платформы
      • Уровни производительности vCPU
      • Графические ускорители (GPU)
      • Прерываемые виртуальные машины
      • Сеть на виртуальной машине
      • Динамическая миграция
      • Группы размещения
      • Статусы
      • Метаданные
    • Диски
      • Обзор
      • Снимки дисков
    • Образы
    • Группы виртуальных машин
      • Обзор
      • Доступ
      • Шаблон виртуальной машины
      • Переменные в шаблоне виртуальной машины
      • Политики
        • Обзор
        • Политика распределения
        • Политика развертывания
        • Политика масштабирования
      • Типы масштабирования
      • Автоматическое восстановление
      • Обновление
        • Обзор
        • Распределение виртуальных машин по зонам
        • Алгоритм развертывания
        • Правила обновления виртуальных машин
      • Статусы
    • Выделенный хост
    • Резервное копирование
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
    • Действующие правила
    • Архив
      • До 1 января 2019 года
      • С 1 января до 1 марта 2019 года
      • С 1 марта до 1 мая 2019 года
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • DiskService
      • DiskTypeService
      • HostGroupService
      • HostTypeService
      • ImageService
      • InstanceService
      • PlacementGroupService
      • SnapshotService
      • ZoneService
      • InstanceGroupService
      • OperationService
    • REST
      • Обзор
      • Disk
        • Обзор
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • DiskType
        • Обзор
        • get
        • list
      • HostGroup
        • Обзор
        • create
        • delete
        • get
        • list
        • listHosts
        • listInstances
        • listOperations
        • update
      • HostType
        • Обзор
        • get
        • list
      • Image
        • Обзор
        • create
        • delete
        • get
        • getLatestByFamily
        • list
        • listOperations
        • update
      • Instance
        • Обзор
        • attachDisk
        • create
        • delete
        • detachDisk
        • get
        • getSerialPortOutput
        • list
        • listOperations
        • restart
        • start
        • stop
        • update
        • updateMetadata
      • PlacementGroup
        • Обзор
        • create
        • delete
        • get
        • list
        • listInstances
        • listOperations
        • update
      • Snapshot
        • Обзор
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • Zone
        • Обзор
        • get
        • list
      • Operation
        • Обзор
        • get
      • InstanceGroup
        • Обзор
        • createFromYaml
        • update
        • list
        • get
        • delete
        • start
        • stop
        • create
        • updateFromYaml
        • listLogRecords
        • listInstances
        • listOperations
  • Вопросы и ответы
    • Общие вопросы
    • Виртуальные машины
    • Диски и снимки
    • Аварийное восстановление
    • Лицензирование
    • Все вопросы на одной странице
  1. Справочник API
  2. REST
  3. HostGroup
  4. listInstances

Метод listInstances

  • HTTP-запрос
  • Path-параметры
  • Query-параметры
  • Ответ

Список ВМ, привязанных к указанной группе выделенных хостов.

HTTP-запрос

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

Path-параметры

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

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter Параметры фильтрации ресурсов в ответе. В настоящее время фильтрация осуществляется только по полю id. Чтобы получить идентификатор выделенного хоста, используйте запрос listHosts. Максимальная длина строки в символах — 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>.&lt;region_id&gt;.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 для продолжения перебора страниц результатов.

В этой статье:
  • HTTP-запрос
  • Path-параметры
  • Query-параметры
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»