Метод listInstances
Список ВМ, привязанных к указанной группе выделенных хостов.
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 Метки ресурса в формате |
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 Статус виртуальной машины.
|
instances[]. metadata |
object Метаданные в формате пар Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
instances[]. bootDisk |
object Загрузочный диск, подключенный к виртуальной машине. |
instances[]. bootDisk. mode |
string Режим доступа к ресурсу Disk.
|
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.
|
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-адреса.
|
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-адреса.
|
instances[]. fqdn |
string Доменное имя виртуальной машины. FQDN определяется сервером в формате |
instances[]. schedulingPolicy |
object Конфигурация политики планирования. |
instances[]. schedulingPolicy. preemptible |
boolean (boolean) Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
instances[]. serviceAccountId |
string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос list. |
instances[]. networkSettings |
object Не указывайте это поле, сетевые настройки пока не поддерживаются. |
instances[]. networkSettings. type |
string Не указывайте это поле, сетевые настройки пока не поддерживаются.
|
nextPageToken | string Этот токен позволяет получить следующую страницу результатов для списка запросов. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Каждая следующая страница будет иметь свой nextPageToken для продолжения перебора страниц результатов. |