Метод listInstances
Возвращает список виртуальных машин для указанной группы ВМ.
HTTP-запрос
GET https://compute.api.cloud.yandex.net/compute/v1/instanceGroups/{instanceGroupId}/instances
Path-параметры
Параметр | Описание |
---|---|
instanceGroupId | Обязательное поле. Идентификатор ресурса InstanceGroup для получения списка виртуальных машин. Чтобы получить идентификатор группы виртуальных машин, используйте запрос list. Максимальная длина строки в символах — 50. |
Query-параметры
Параметр | Описание |
---|---|
pageSize | Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
pageToken | Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | Параметры фильтрации ресурсов в ответе. В настоящее время фильтрация осуществляется только по полю InstanceGroup.name. Максимальная длина строки в символах — 1000. |
Ответ
HTTP Code: 200 - OK
{
"instances": [
{
"id": "string",
"status": "string",
"instanceId": "string",
"fqdn": "string",
"name": "string",
"statusMessage": "string",
"zoneId": "string",
"networkInterfaces": [
{
"index": "string",
"macAddress": "string",
"subnetId": "string",
"primaryV4Address": {
"address": "string",
"oneToOneNat": {
"address": "string",
"ipVersion": "string"
}
},
"primaryV6Address": {
"address": "string",
"oneToOneNat": {
"address": "string",
"ipVersion": "string"
}
}
}
],
"statusChangedAt": "string"
}
],
"nextPageToken": "string"
}
Поле | Описание |
---|---|
instances[] | object Ресурс ManagedInstance. Дополнительные сведения см. в разделе Концепции Instance Groups. |
instances[]. id |
string Идентификатор виртуальной машины. |
instances[]. status |
string Статус виртуальной машины.
|
instances[]. instanceId |
string Идентификатор виртуальной машины. |
instances[]. fqdn |
string Полное имя домена. |
instances[]. name |
string Имя управляемой виртуальной машины. |
instances[]. statusMessage |
string Сообщение о состоянии виртуальной машины. |
instances[]. zoneId |
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-адрес, назначенный виртуальной машине для данного сетевого интерфейса. Если не указано, системой будет назначен неиспользуемый внутренний IP-адрес. |
instances[]. networkInterfaces[]. primaryV4Address. oneToOneNat |
object Конфигурация one-to-one NAT. Если отсутствует, NAT не был настроен. |
instances[]. networkInterfaces[]. primaryV4Address. oneToOneNat. address |
string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. |
instances[]. networkInterfaces[]. primaryV4Address. oneToOneNat. ipVersion |
string Версия публичного IP-адреса.
|
instances[]. networkInterfaces[]. primaryV6Address |
object Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
instances[]. networkInterfaces[]. primaryV6Address. address |
string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. Если не указано, системой будет назначен неиспользуемый внутренний IP-адрес. |
instances[]. networkInterfaces[]. primaryV6Address. oneToOneNat |
object Конфигурация one-to-one NAT. Если отсутствует, NAT не был настроен. |
instances[]. networkInterfaces[]. primaryV6Address. oneToOneNat. address |
string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. |
instances[]. networkInterfaces[]. primaryV6Address. oneToOneNat. ipVersion |
string Версия публичного IP-адреса.
|
instances[]. statusChangedAt |
string (date-time) Время последнего изменения состояния виртуальной машины в формате RFC3339. Строка в формате RFC3339. |
nextPageToken | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |