Метод get
Возвращает указанный ресурс Instance.
Чтобы получить список доступных ресурсов Instance, используйте запрос list.
HTTP-запрос
GET https://compute.api.cloud.yandex.net/compute/v1/instances/{instanceId}
Path-параметры
Параметр | Описание |
---|---|
instanceId | Обязательное поле. Идентификатор возвращаемого ресурса Instance. Чтобы получить идентификатор виртуальной машины, используйте запрос list. Максимальная длина строки в символах — 50. |
Query-параметры
Параметр | Описание |
---|---|
view | Определяет, какая информация о ресурсе Instance должна быть возвращена в ответе сервера.
|
Ответ
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",
"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"
}
}
Ресурс Instance. Дополнительные сведения см. в разделе Виртуальные машины.
Поле | Описание |
---|---|
id | string Идентификатор виртуальной машины. |
folderId | string Идентификатор каталога, которому принадлежит виртуальная машина. |
createdAt | string (date-time) Строка в формате RFC3339. |
name | string Имя виртуальной машины. Длина 1-63 символов. |
description | string Описание виртуальной машины. Длина описания должна быть от 0 до 256 символов. |
labels | object Метки ресурса в формате |
zoneId | string Идентификатор зоны доступности, где находится виртуальная машина. |
platformId | string Идентификатор аппаратной платформы виртуальной машины. |
resources | object Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
resources. memory |
string (int64) Объем памяти в байтах, доступный виртуальной машине. |
resources. cores |
string (int64) Количество ядер, доступное виртуальной машине. |
resources. coreFraction |
string (int64) Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. |
resources. gpus |
string (int64) Количество GPU, доступное виртуальной машине. |
status | string Статус виртуальной машины.
|
metadata | object Метаданные в формате пар Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
bootDisk | object Загрузочный диск, подключенный к виртуальной машине. |
bootDisk. mode |
string Режим доступа к ресурсу Disk.
|
bootDisk. deviceName |
string Cерийный номер, который отображается в директории /dev/disk/by-id/ на виртуальной машине с операционной системой Linux. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. |
bootDisk. autoDelete |
boolean (boolean) Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
bootDisk. diskId |
string Идентификатор диска, подключенного к виртуальной машине. |
secondaryDisks[] | object Массив дополнительных дисков, подключенных к виртуальной машине. |
secondaryDisks[]. mode |
string Режим доступа к ресурсу Disk.
|
secondaryDisks[]. deviceName |
string Cерийный номер, который отображается в директории /dev/disk/by-id/ на виртуальной машине с операционной системой Linux. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. |
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 Основной 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-адреса.
|
networkInterfaces[]. primaryV6Address |
object Основной 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-адреса.
|
fqdn | string Доменное имя виртуальной машины. FQDN определяется сервером в формате |
schedulingPolicy | object Конфигурация политики планирования. |
schedulingPolicy. preemptible |
boolean (boolean) Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
serviceAccountId | string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос list. |
networkSettings | object Не указывайте это поле, сетевые настройки пока не поддерживаются. |
networkSettings. type |
string Не указывайте это поле, сетевые настройки пока не поддерживаются.
|