InstanceService
Набор методов для управления ресурсами Instance.
Вызов | Описание |
---|---|
Get | Возвращает указанный ресурс Instance. |
List | Возвращает список доступных ресурсов Instance в указанном каталоге. |
Create | Создает виртуальную машину в указанном каталоге. |
Update | Изменяет указанную виртуальную машину. |
Delete | Удаляет указанную виртуальную машину. |
UpdateMetadata | Обновляет метаданные указанной виртуальной машины. |
GetSerialPortOutput | Возвращает вывод последовательного порта указанного ресурса Instance. |
Stop | Останавливает запущенную виртуальную машину. |
Start | Запускает остановленную виртуальную машину. |
Restart | Перезапускает работающую виртуальную машину. |
AttachDisk | Присоединяет диск к виртуальной машине. |
DetachDisk | Отсоединяет диск от виртуальной машины. |
ListOperations | Возвращает список операций для указанной виртуальной машины. |
Вызовы InstanceService
Get
Возвращает указанный ресурс Instance.
Чтобы получить список доступных ресурсов Instance, используйте запрос List.
rpc Get (GetInstanceRequest) returns (Instance)
GetInstanceRequest
Поле | Описание |
---|---|
instance_id | string Обязательное поле. Идентификатор возвращаемого ресурса Instance. Чтобы получить идентификатор виртуальной машины, используйте запрос InstanceService.List. Максимальная длина строки в символах — 50. |
view | enum InstanceView Определяет, какая информация о ресурсе Instance должна быть возвращена в ответе сервера.
|
Instance
Поле | Описание |
---|---|
id | string Идентификатор виртуальной машины. |
folder_id | string Идентификатор каталога, которому принадлежит виртуальная машина. |
created_at | google.protobuf.Timestamp |
name | string Имя виртуальной машины. Длина 1-63 символов. |
description | string Описание виртуальной машины. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
zone_id | string Идентификатор зоны доступности, где находится виртуальная машина. |
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources | Resources Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
status | enum Status Статус виртуальной машины.
|
metadata | map<string,string> Метаданные в формате пар key:value , назначаемые данной виртуальной машине. Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
boot_disk | AttachedDisk Загрузочный диск, подключенный к виртуальной машине. |
secondary_disks[] | AttachedDisk Массив дополнительных дисков, подключенных к виртуальной машине. |
network_interfaces[] | NetworkInterface Массив сетевых интерфейсов, присоединенных к виртуальной машине. |
fqdn | string Доменное имя виртуальной машины. FQDN определяется сервером в формате <hostname>.<region_id>.internal при создании виртуальной машины. Если имя хоста не было указано при создании виртуальной машины, FQDN будет <id>.auto.internal . |
scheduling_policy | SchedulingPolicy Конфигурация политики планирования. |
service_account_id | string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
network_settings | NetworkSettings Не указывайте это поле, сетевые настройки пока не поддерживаются. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. |
cores | int64 Количество ядер, доступное виртуальной машине. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. |
gpus | int64 Количество GPU, доступное виртуальной машине. |
AttachedDisk
Поле | Описание |
---|---|
mode | enum Mode Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который отображается в директории /dev/disk/by-id/ на виртуальной машине с операционной системой Linux. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. |
auto_delete | bool Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
disk_id | string Идентификатор диска, подключенного к виртуальной машине. |
NetworkInterface
Поле | Описание |
---|---|
index | string Индекс сетевого интерфейса, генерируемого сервером, 0,1,2... В настоящее время для каждой виртуальной машины поддерживается только один сетевой интерфейс. |
mac_address | string MAC-адрес, назначенный сетевому интерфейсу. |
subnet_id | string Идентификатор подсети. |
primary_v4_address | PrimaryAddress Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address | PrimaryAddress Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddress
Поле | Описание |
---|---|
address | string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. |
one_to_one_nat | OneToOneNat Конфигурация one-to-one NAT. Если она отсутствует, NAT не был настроен. |
OneToOneNat
Поле | Описание |
---|---|
address | string Публичный IP-адрес, связанный с данной виртуальной машиной. |
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
NetworkSettings
Поле | Описание |
---|---|
type | enum Type Не указывайте это поле, сетевые настройки пока не поддерживаются.
|
List
Возвращает список доступных ресурсов Instance в указанном каталоге.
rpc List (ListInstancesRequest) returns (ListInstancesResponse)
ListInstancesRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для получения списка виртуальных машин. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListInstancesResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListInstancesResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListInstancesResponse
Поле | Описание |
---|---|
instances[] | Instance Список ресурсов Instance. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListInstancesRequest.page_size, используйте next_page_token в качестве значения параметра ListInstancesRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Instance
Поле | Описание |
---|---|
id | string Идентификатор виртуальной машины. |
folder_id | string Идентификатор каталога, которому принадлежит виртуальная машина. |
created_at | google.protobuf.Timestamp |
name | string Имя виртуальной машины. Длина 1-63 символов. |
description | string Описание виртуальной машины. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
zone_id | string Идентификатор зоны доступности, где находится виртуальная машина. |
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources | Resources Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
status | enum Status Статус виртуальной машины.
|
metadata | map<string,string> Метаданные в формате пар key:value , назначаемые данной виртуальной машине. Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
boot_disk | AttachedDisk Загрузочный диск, подключенный к виртуальной машине. |
secondary_disks[] | AttachedDisk Массив дополнительных дисков, подключенных к виртуальной машине. |
network_interfaces[] | NetworkInterface Массив сетевых интерфейсов, присоединенных к виртуальной машине. |
fqdn | string Доменное имя виртуальной машины. FQDN определяется сервером в формате <hostname>.<region_id>.internal при создании виртуальной машины. Если имя хоста не было указано при создании виртуальной машины, FQDN будет <id>.auto.internal . |
scheduling_policy | SchedulingPolicy Конфигурация политики планирования. |
service_account_id | string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
network_settings | NetworkSettings Не указывайте это поле, сетевые настройки пока не поддерживаются. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. |
cores | int64 Количество ядер, доступное виртуальной машине. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. |
gpus | int64 Количество GPU, доступное виртуальной машине. |
AttachedDisk
Поле | Описание |
---|---|
mode | enum Mode Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который отображается в директории /dev/disk/by-id/ на виртуальной машине с операционной системой Linux. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. |
auto_delete | bool Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
disk_id | string Идентификатор диска, подключенного к виртуальной машине. |
NetworkInterface
Поле | Описание |
---|---|
index | string Индекс сетевого интерфейса, генерируемого сервером, 0,1,2... В настоящее время для каждой виртуальной машины поддерживается только один сетевой интерфейс. |
mac_address | string MAC-адрес, назначенный сетевому интерфейсу. |
subnet_id | string Идентификатор подсети. |
primary_v4_address | PrimaryAddress Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address | PrimaryAddress Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddress
Поле | Описание |
---|---|
address | string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. |
one_to_one_nat | OneToOneNat Конфигурация one-to-one NAT. Если она отсутствует, NAT не был настроен. |
OneToOneNat
Поле | Описание |
---|---|
address | string Публичный IP-адрес, связанный с данной виртуальной машиной. |
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
NetworkSettings
Поле | Описание |
---|---|
type | enum Type Не указывайте это поле, сетевые настройки пока не поддерживаются.
|
Create
Создает виртуальную машину в указанном каталоге. Метод запускает асинхронную операцию, которую можно отменить перед тем, как она завершится.
rpc Create (CreateInstanceRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateInstanceMetadata
Operation.response:Instance
CreateInstanceRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для создания виртуальной машины. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
name | string Имя виртуальной машины. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате key:value . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
zone_id | string Обязательное поле. Идентификатор зоны доступности, где находится виртуальная машина. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50. |
platform_id | string Обязательное поле. Идентификатор аппаратной платформы виртуальной машины. Это поле влияет на допустимые значения поля resources_spec . Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Обязательное поле. Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. Чтобы узнать список допустимых значений, см. раздел Уровни производительности vCPU. |
metadata | map<string,string> Метаданные, назначаемые данной виртуальной машине, в формате пар ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Общий размер всех ключей и значений не должен превышать 512 КБ. Значениями являются строки и используются только программами, которые настраивают виртуальную машину. Значения должны быть не более 256 КБ. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
boot_disk_spec | AttachedDiskSpec Обязательное поле. Загрузочный диск для подключения к виртуальной машине. |
secondary_disk_specs[] | AttachedDiskSpec Массив дополнительных дисков для подключения к виртуальной машине. Максимальное количество элементов — 3. |
network_interface_specs[] | NetworkInterfaceSpec Конфигурация сети для виртуальной машины. Указывает, как должен быть настроен сетевой интерфейс для взаимодействия с другими сервисами во внутренней сети и в интернете. В настоящее время для каждой виртуальной машины поддерживается только один сетевой интерфейс. Количество элементов должно быть ровно 1. |
hostname | string Имя хоста виртуальной машины. Это поле используется для генерации значения yandex.cloud.compute.v1.Instance.fqdn. Имя хоста должно быть уникальным в пределах сети и региона. Если не указано, то имя хоста будет равно yandex.cloud.compute.v1.Instance.id виртуальной машины и FQDN будет <id>.auto.internal . В противном случае FQDN будет <hostname>.<region_id>.internal . Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
scheduling_policy | SchedulingPolicy Конфигурация политики планирования. |
service_account_id | string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
network_settings | NetworkSettings Сетевые настройки. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Обязательное поле. Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Обязательное поле. Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Например, если требуется только 5% производительности CPU, можно задать значение core_fraction=5 . Дополнительные сведения см. в разделе Уровни производительности vCPU. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Режим, в котором необходимо подключить этот диск.
|
device_name | string Задает уникальный серийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Если значение не указано, будет сгенерировано случайное значение. Значение должно соответствовать регулярному выражению [a-z][a-z0-9-_]{,19} . |
auto_delete | bool Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
disk | oneof: disk_spec или disk_id |
disk_spec | DiskSpec Спецификация диска. |
disk_id | string Идентификатор диска, который должен быть подключен. Максимальная длина строки в символах — 50. |
DiskSpec
Поле | Описание |
---|---|
name | string Имя диска. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Идентификатор типа диска. Чтобы получить список доступных типов дисков, используйте запрос yandex.cloud.compute.v1.DiskTypeService.List. Максимальная длина строки в символах — 50. |
size | int64 Обязательное поле. Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа для создания диска. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка для восстановления диска. Максимальная длина строки в символах — 50. |
NetworkInterfaceSpec
Поле | Описание |
---|---|
subnet_id | string Обязательное поле. Идентификатор подсети. Максимальная длина строки в символах — 50. |
primary_v4_address_spec | PrimaryAddressSpec Основной IPv4-адрес, который будет назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address_spec | PrimaryAddressSpec Основной IPv6-адрес, который будет назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddressSpec
Поле | Описание |
---|---|
address | string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. Если он не указан, системой будет назначен неиспользуемый внутренний IP-адрес. |
one_to_one_nat_spec | OneToOneNatSpec Конфигурация внешнего IP-адреса. Если она не указана, то у виртуальной машины не будет доступа в интернет. |
OneToOneNatSpec
Поле | Описание |
---|---|
ip_version | enum IpVersion Обязательное поле. Версия публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
NetworkSettings
Поле | Описание |
---|---|
type | enum Type Не указывайте это поле, сетевые настройки пока не поддерживаются.
|
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateInstanceMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Instance> в случае успешного выполнения операции. |
CreateInstanceMetadata
Поле | Описание |
---|---|
instance_id | string Идентификатор создаваемой виртуальной машины. Максимальная длина строки в символах — 50. |
Instance
Поле | Описание |
---|---|
id | string Идентификатор виртуальной машины. |
folder_id | string Идентификатор каталога, которому принадлежит виртуальная машина. |
created_at | google.protobuf.Timestamp |
name | string Имя виртуальной машины. Длина 1-63 символов. |
description | string Описание виртуальной машины. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
zone_id | string Идентификатор зоны доступности, где находится виртуальная машина. |
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources | Resources Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
status | enum Status Статус виртуальной машины.
|
metadata | map<string,string> Метаданные в формате пар key:value , назначаемые данной виртуальной машине. Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
boot_disk | AttachedDisk Загрузочный диск, подключенный к виртуальной машине. |
secondary_disks[] | AttachedDisk Массив дополнительных дисков, подключенных к виртуальной машине. |
network_interfaces[] | NetworkInterface Массив сетевых интерфейсов, присоединенных к виртуальной машине. |
fqdn | string Доменное имя виртуальной машины. FQDN определяется сервером в формате <hostname>.<region_id>.internal при создании виртуальной машины. Если имя хоста не было указано при создании виртуальной машины, FQDN будет <id>.auto.internal . |
scheduling_policy | SchedulingPolicy Конфигурация политики планирования. |
service_account_id | string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
network_settings | NetworkSettings Не указывайте это поле, сетевые настройки пока не поддерживаются. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. |
cores | int64 Количество ядер, доступное виртуальной машине. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. |
gpus | int64 Количество GPU, доступное виртуальной машине. |
AttachedDisk
Поле | Описание |
---|---|
mode | enum Mode Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который отображается в директории /dev/disk/by-id/ на виртуальной машине с операционной системой Linux. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. |
auto_delete | bool Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
disk_id | string Идентификатор диска, подключенного к виртуальной машине. |
NetworkInterface
Поле | Описание |
---|---|
index | string Индекс сетевого интерфейса, генерируемого сервером, 0,1,2... В настоящее время для каждой виртуальной машины поддерживается только один сетевой интерфейс. |
mac_address | string MAC-адрес, назначенный сетевому интерфейсу. |
subnet_id | string Идентификатор подсети. |
primary_v4_address | PrimaryAddress Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address | PrimaryAddress Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddress
Поле | Описание |
---|---|
address | string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. |
one_to_one_nat | OneToOneNat Конфигурация one-to-one NAT. Если она отсутствует, NAT не был настроен. |
OneToOneNat
Поле | Описание |
---|---|
address | string Публичный IP-адрес, связанный с данной виртуальной машиной. |
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
NetworkSettings
Поле | Описание |
---|---|
type | enum Type Не указывайте это поле, сетевые настройки пока не поддерживаются.
|
Update
Изменяет указанную виртуальную машину.
rpc Update (UpdateInstanceRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateInstanceMetadata
Operation.response:Instance
UpdateInstanceRequest
Поле | Описание |
---|---|
instance_id | string Обязательное поле. Идентификатор изменяемого ресурса Instance. Чтобы получить идентификатор виртуальной машины, используйте запрос InstanceService.List. Максимальная длина строки в символах — 50. |
update_mask | google.protobuf.FieldMask Маска, определяющая, какие поля ресурса Disk будут обновлены. |
name | string Имя виртуальной машины. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание виртуальной машины. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате key:value . Существующий набор labels полностью перезаписывается набором, переданным в запросе. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
platform_id | string Идентификатор аппаратной платформы виртуальной машины. Это поле влияет на допустимые значения поля resources_spec . Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы. |
resources_spec | ResourcesSpec Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. Чтобы узнать список допустимых значений, см. раздел Уровни производительности vCPU. |
metadata | map<string,string> Метаданные, назначаемые данной виртуальной машине, в формате пар ключ:значение . Сюда входят пользовательские метаданные и предопределенные ключи. Общий размер всех ключей и значений не должен превышать 512 КБ. Существующий набор metadata полностью перезаписывается набором, переданным в запросе. Значениями являются строки и используются только программами, которые настраивают виртуальную машину. Значения должны быть не более 256 КБ. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
service_account_id | string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
network_settings | NetworkSettings Сетевые настройки. |
ResourcesSpec
Поле | Описание |
---|---|
memory | int64 Обязательное поле. Объем памяти в байтах, доступный виртуальной машине. Максимальное значение — 274877906944. |
cores | int64 Обязательное поле. Количество ядер, доступное виртуальной машине. Значение должно быть равно 1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Например, если требуется только 5% производительности CPU, можно задать значение core_fraction=5 . Дополнительные сведения см. в разделе Уровни производительности vCPU. Значение должно быть равно 0,5,20,50,100. |
gpus | int64 Количество GPU, доступное виртуальной машине. Значение должно быть равно 0,1,2,4. |
NetworkSettings
Поле | Описание |
---|---|
type | enum Type Не указывайте это поле, сетевые настройки пока не поддерживаются.
|
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateInstanceMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Instance> в случае успешного выполнения операции. |
UpdateInstanceMetadata
Поле | Описание |
---|---|
instance_id | string Идентификатор изменяемого ресурса Instance. |
Instance
Поле | Описание |
---|---|
id | string Идентификатор виртуальной машины. |
folder_id | string Идентификатор каталога, которому принадлежит виртуальная машина. |
created_at | google.protobuf.Timestamp |
name | string Имя виртуальной машины. Длина 1-63 символов. |
description | string Описание виртуальной машины. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
zone_id | string Идентификатор зоны доступности, где находится виртуальная машина. |
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources | Resources Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
status | enum Status Статус виртуальной машины.
|
metadata | map<string,string> Метаданные в формате пар key:value , назначаемые данной виртуальной машине. Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
boot_disk | AttachedDisk Загрузочный диск, подключенный к виртуальной машине. |
secondary_disks[] | AttachedDisk Массив дополнительных дисков, подключенных к виртуальной машине. |
network_interfaces[] | NetworkInterface Массив сетевых интерфейсов, присоединенных к виртуальной машине. |
fqdn | string Доменное имя виртуальной машины. FQDN определяется сервером в формате <hostname>.<region_id>.internal при создании виртуальной машины. Если имя хоста не было указано при создании виртуальной машины, FQDN будет <id>.auto.internal . |
scheduling_policy | SchedulingPolicy Конфигурация политики планирования. |
service_account_id | string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
network_settings | NetworkSettings Не указывайте это поле, сетевые настройки пока не поддерживаются. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. |
cores | int64 Количество ядер, доступное виртуальной машине. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. |
gpus | int64 Количество GPU, доступное виртуальной машине. |
AttachedDisk
Поле | Описание |
---|---|
mode | enum Mode Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который отображается в директории /dev/disk/by-id/ на виртуальной машине с операционной системой Linux. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. |
auto_delete | bool Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
disk_id | string Идентификатор диска, подключенного к виртуальной машине. |
NetworkInterface
Поле | Описание |
---|---|
index | string Индекс сетевого интерфейса, генерируемого сервером, 0,1,2... В настоящее время для каждой виртуальной машины поддерживается только один сетевой интерфейс. |
mac_address | string MAC-адрес, назначенный сетевому интерфейсу. |
subnet_id | string Идентификатор подсети. |
primary_v4_address | PrimaryAddress Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address | PrimaryAddress Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddress
Поле | Описание |
---|---|
address | string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. |
one_to_one_nat | OneToOneNat Конфигурация one-to-one NAT. Если она отсутствует, NAT не был настроен. |
OneToOneNat
Поле | Описание |
---|---|
address | string Публичный IP-адрес, связанный с данной виртуальной машиной. |
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
NetworkSettings
Поле | Описание |
---|---|
type | enum Type Не указывайте это поле, сетевые настройки пока не поддерживаются.
|
Delete
Удаляет указанную виртуальную машину.
rpc Delete (DeleteInstanceRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteInstanceMetadata
Operation.response:google.protobuf.Empty
DeleteInstanceRequest
Поле | Описание |
---|---|
instance_id | string Обязательное поле. Идентификатор удаляемой виртуальной машины. Чтобы получить идентификатор виртуальной машины, используйте запрос InstanceService.List. Максимальная длина строки в символах — 50. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<DeleteInstanceMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
DeleteInstanceMetadata
Поле | Описание |
---|---|
instance_id | string Идентификатор удаляемой виртуальной машины. |
UpdateMetadata
Обновляет метаданные указанной виртуальной машины.
rpc UpdateMetadata (UpdateInstanceMetadataRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateInstanceMetadataMetadata
Operation.response:Instance
UpdateInstanceMetadataRequest
Поле | Описание |
---|---|
instance_id | string Идентификатор изменяемой виртуальной машины. |
delete[] | string Список ключей для удаления. |
upsert | map<string,string> Метаданные в формате пар ключ:значение , которые будут добавлены или обновлены для данной виртуальной машины. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateInstanceMetadataMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Instance> в случае успешного выполнения операции. |
UpdateInstanceMetadataMetadata
Поле | Описание |
---|---|
instance_id | string Идентификатор изменяемой виртуальной машины. |
Instance
Поле | Описание |
---|---|
id | string Идентификатор виртуальной машины. |
folder_id | string Идентификатор каталога, которому принадлежит виртуальная машина. |
created_at | google.protobuf.Timestamp |
name | string Имя виртуальной машины. Длина 1-63 символов. |
description | string Описание виртуальной машины. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
zone_id | string Идентификатор зоны доступности, где находится виртуальная машина. |
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources | Resources Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
status | enum Status Статус виртуальной машины.
|
metadata | map<string,string> Метаданные в формате пар key:value , назначаемые данной виртуальной машине. Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
boot_disk | AttachedDisk Загрузочный диск, подключенный к виртуальной машине. |
secondary_disks[] | AttachedDisk Массив дополнительных дисков, подключенных к виртуальной машине. |
network_interfaces[] | NetworkInterface Массив сетевых интерфейсов, присоединенных к виртуальной машине. |
fqdn | string Доменное имя виртуальной машины. FQDN определяется сервером в формате <hostname>.<region_id>.internal при создании виртуальной машины. Если имя хоста не было указано при создании виртуальной машины, FQDN будет <id>.auto.internal . |
scheduling_policy | SchedulingPolicy Конфигурация политики планирования. |
service_account_id | string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
network_settings | NetworkSettings Не указывайте это поле, сетевые настройки пока не поддерживаются. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. |
cores | int64 Количество ядер, доступное виртуальной машине. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. |
gpus | int64 Количество GPU, доступное виртуальной машине. |
AttachedDisk
Поле | Описание |
---|---|
mode | enum Mode Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который отображается в директории /dev/disk/by-id/ на виртуальной машине с операционной системой Linux. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. |
auto_delete | bool Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
disk_id | string Идентификатор диска, подключенного к виртуальной машине. |
NetworkInterface
Поле | Описание |
---|---|
index | string Индекс сетевого интерфейса, генерируемого сервером, 0,1,2... В настоящее время для каждой виртуальной машины поддерживается только один сетевой интерфейс. |
mac_address | string MAC-адрес, назначенный сетевому интерфейсу. |
subnet_id | string Идентификатор подсети. |
primary_v4_address | PrimaryAddress Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address | PrimaryAddress Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddress
Поле | Описание |
---|---|
address | string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. |
one_to_one_nat | OneToOneNat Конфигурация one-to-one NAT. Если она отсутствует, NAT не был настроен. |
OneToOneNat
Поле | Описание |
---|---|
address | string Публичный IP-адрес, связанный с данной виртуальной машиной. |
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
NetworkSettings
Поле | Описание |
---|---|
type | enum Type Не указывайте это поле, сетевые настройки пока не поддерживаются.
|
GetSerialPortOutput
Возвращает вывод последовательного порта указанного ресурса Instance.
rpc GetSerialPortOutput (GetInstanceSerialPortOutputRequest) returns (GetInstanceSerialPortOutputResponse)
GetInstanceSerialPortOutputRequest
Поле | Описание |
---|---|
instance_id | string Обязательное поле. Идентификатор виртуальной машины для получения вывода последовательного порта. Максимальная длина строки в символах — 50. |
port | int64 Последовательный порт из которого извлекаются данные. Значение по умолчанию — 1. Значение должно быть равно 1,2,3,4. |
GetInstanceSerialPortOutputResponse
Поле | Описание |
---|---|
contents | string Содержимое вывода последовательного порта, начиная с момента начала загрузки виртуальной машины. |
Stop
Останавливает запущенную виртуальную машину.
Вы можете запустить виртуальную машину позже, используя метод InstanceService.Start.
rpc Stop (StopInstanceRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StopInstanceMetadata
Operation.response:google.protobuf.Empty
StopInstanceRequest
Поле | Описание |
---|---|
instance_id | string Обязательное поле. Идентификатор останавливаемой виртуальной машины. Чтобы получить идентификатор виртуальной машины, используйте запрос InstanceService.List. Максимальная длина строки в символах — 50. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<StopInstanceMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
StopInstanceMetadata
Поле | Описание |
---|---|
instance_id | string Идентификатор удаляемой виртуальной машины. |
Start
Запускает остановленную виртуальную машину.
rpc Start (StartInstanceRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StartInstanceMetadata
Operation.response:Instance
StartInstanceRequest
Поле | Описание |
---|---|
instance_id | string Обязательное поле. Идентификатор запускаемой виртуальной машины. Чтобы получить идентификатор виртуальной машины, используйте запрос InstanceService.List. Максимальная длина строки в символах — 50. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<StartInstanceMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Instance> в случае успешного выполнения операции. |
StartInstanceMetadata
Поле | Описание |
---|---|
instance_id | string Идентификатор виртуальной машины. |
Instance
Поле | Описание |
---|---|
id | string Идентификатор виртуальной машины. |
folder_id | string Идентификатор каталога, которому принадлежит виртуальная машина. |
created_at | google.protobuf.Timestamp |
name | string Имя виртуальной машины. Длина 1-63 символов. |
description | string Описание виртуальной машины. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
zone_id | string Идентификатор зоны доступности, где находится виртуальная машина. |
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources | Resources Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
status | enum Status Статус виртуальной машины.
|
metadata | map<string,string> Метаданные в формате пар key:value , назначаемые данной виртуальной машине. Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
boot_disk | AttachedDisk Загрузочный диск, подключенный к виртуальной машине. |
secondary_disks[] | AttachedDisk Массив дополнительных дисков, подключенных к виртуальной машине. |
network_interfaces[] | NetworkInterface Массив сетевых интерфейсов, присоединенных к виртуальной машине. |
fqdn | string Доменное имя виртуальной машины. FQDN определяется сервером в формате <hostname>.<region_id>.internal при создании виртуальной машины. Если имя хоста не было указано при создании виртуальной машины, FQDN будет <id>.auto.internal . |
scheduling_policy | SchedulingPolicy Конфигурация политики планирования. |
service_account_id | string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
network_settings | NetworkSettings Не указывайте это поле, сетевые настройки пока не поддерживаются. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. |
cores | int64 Количество ядер, доступное виртуальной машине. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. |
gpus | int64 Количество GPU, доступное виртуальной машине. |
AttachedDisk
Поле | Описание |
---|---|
mode | enum Mode Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который отображается в директории /dev/disk/by-id/ на виртуальной машине с операционной системой Linux. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. |
auto_delete | bool Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
disk_id | string Идентификатор диска, подключенного к виртуальной машине. |
NetworkInterface
Поле | Описание |
---|---|
index | string Индекс сетевого интерфейса, генерируемого сервером, 0,1,2... В настоящее время для каждой виртуальной машины поддерживается только один сетевой интерфейс. |
mac_address | string MAC-адрес, назначенный сетевому интерфейсу. |
subnet_id | string Идентификатор подсети. |
primary_v4_address | PrimaryAddress Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address | PrimaryAddress Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddress
Поле | Описание |
---|---|
address | string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. |
one_to_one_nat | OneToOneNat Конфигурация one-to-one NAT. Если она отсутствует, NAT не был настроен. |
OneToOneNat
Поле | Описание |
---|---|
address | string Публичный IP-адрес, связанный с данной виртуальной машиной. |
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
NetworkSettings
Поле | Описание |
---|---|
type | enum Type Не указывайте это поле, сетевые настройки пока не поддерживаются.
|
Restart
Перезапускает работающую виртуальную машину.
rpc Restart (RestartInstanceRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:RestartInstanceMetadata
Operation.response:google.protobuf.Empty
RestartInstanceRequest
Поле | Описание |
---|---|
instance_id | string Обязательное поле. Идентификатор виртуальной машины, которую необходимо перезапустить. Чтобы получить идентификатор виртуальной машины, используйте запрос InstanceService.List. Максимальная длина строки в символах — 50. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<RestartInstanceMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
RestartInstanceMetadata
Поле | Описание |
---|---|
instance_id | string Идентификатор виртуальной машины. |
AttachDisk
Присоединяет диск к виртуальной машине.
rpc AttachDisk (AttachInstanceDiskRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:AttachInstanceDiskMetadata
Operation.response:Instance
AttachInstanceDiskRequest
Поле | Описание |
---|---|
instance_id | string Обязательное поле. Идентификатор виртуальной машины для подключения диска. Чтобы получить идентификатор виртуальной машины, используйте запрос InstanceService.List. Максимальная длина строки в символах — 50. |
attached_disk_spec | AttachedDiskSpec Обязательное поле. Диск для подключения. |
AttachedDiskSpec
Поле | Описание |
---|---|
mode | enum Mode Режим, в котором необходимо подключить этот диск.
|
device_name | string Задает уникальный серийный номер, который на виртуальной машине с операционной системой Linux отображается в директории /dev/disk/by-id/. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. Если значение не указано, будет сгенерировано случайное значение. Значение должно соответствовать регулярному выражению [a-z][a-z0-9-_]{,19} . |
auto_delete | bool Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
disk | oneof: disk_spec или disk_id |
disk_spec | DiskSpec Спецификация диска. |
disk_id | string Идентификатор диска, который должен быть подключен. Максимальная длина строки в символах — 50. |
DiskSpec
Поле | Описание |
---|---|
name | string Имя диска. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Описание диска. Максимальная длина строки в символах — 256. |
type_id | string Идентификатор типа диска. Чтобы получить список доступных типов дисков, используйте запрос yandex.cloud.compute.v1.DiskTypeService.List. Максимальная длина строки в символах — 50. |
size | int64 Обязательное поле. Размер диска в байтах. Допустимые значения — от 4194304 до 4398046511104 включительно. |
source | oneof: image_id или snapshot_id |
image_id | string Идентификатор образа для создания диска. Максимальная длина строки в символах — 50. |
snapshot_id | string Идентификатор снимка для восстановления диска. Максимальная длина строки в символах — 50. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<AttachInstanceDiskMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Instance> в случае успешного выполнения операции. |
AttachInstanceDiskMetadata
Поле | Описание |
---|---|
instance_id | string Идентификатор виртуальной машины. |
disk_id | string Идентификатор типа диска. |
Instance
Поле | Описание |
---|---|
id | string Идентификатор виртуальной машины. |
folder_id | string Идентификатор каталога, которому принадлежит виртуальная машина. |
created_at | google.protobuf.Timestamp |
name | string Имя виртуальной машины. Длина 1-63 символов. |
description | string Описание виртуальной машины. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
zone_id | string Идентификатор зоны доступности, где находится виртуальная машина. |
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources | Resources Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
status | enum Status Статус виртуальной машины.
|
metadata | map<string,string> Метаданные в формате пар key:value , назначаемые данной виртуальной машине. Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
boot_disk | AttachedDisk Загрузочный диск, подключенный к виртуальной машине. |
secondary_disks[] | AttachedDisk Массив дополнительных дисков, подключенных к виртуальной машине. |
network_interfaces[] | NetworkInterface Массив сетевых интерфейсов, присоединенных к виртуальной машине. |
fqdn | string Доменное имя виртуальной машины. FQDN определяется сервером в формате <hostname>.<region_id>.internal при создании виртуальной машины. Если имя хоста не было указано при создании виртуальной машины, FQDN будет <id>.auto.internal . |
scheduling_policy | SchedulingPolicy Конфигурация политики планирования. |
service_account_id | string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
network_settings | NetworkSettings Не указывайте это поле, сетевые настройки пока не поддерживаются. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. |
cores | int64 Количество ядер, доступное виртуальной машине. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. |
gpus | int64 Количество GPU, доступное виртуальной машине. |
AttachedDisk
Поле | Описание |
---|---|
mode | enum Mode Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который отображается в директории /dev/disk/by-id/ на виртуальной машине с операционной системой Linux. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. |
auto_delete | bool Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
disk_id | string Идентификатор диска, подключенного к виртуальной машине. |
NetworkInterface
Поле | Описание |
---|---|
index | string Индекс сетевого интерфейса, генерируемого сервером, 0,1,2... В настоящее время для каждой виртуальной машины поддерживается только один сетевой интерфейс. |
mac_address | string MAC-адрес, назначенный сетевому интерфейсу. |
subnet_id | string Идентификатор подсети. |
primary_v4_address | PrimaryAddress Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address | PrimaryAddress Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddress
Поле | Описание |
---|---|
address | string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. |
one_to_one_nat | OneToOneNat Конфигурация one-to-one NAT. Если она отсутствует, NAT не был настроен. |
OneToOneNat
Поле | Описание |
---|---|
address | string Публичный IP-адрес, связанный с данной виртуальной машиной. |
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
NetworkSettings
Поле | Описание |
---|---|
type | enum Type Не указывайте это поле, сетевые настройки пока не поддерживаются.
|
DetachDisk
Отсоединяет диск от виртуальной машины.
rpc DetachDisk (DetachInstanceDiskRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DetachInstanceDiskMetadata
Operation.response:Instance
DetachInstanceDiskRequest
Поле | Описание |
---|---|
instance_id | string Обязательное поле. Идентификатор виртуальной машины, от которой надо отсоединить диск. Чтобы получить идентификатор виртуальной машины, используйте запрос InstanceService.List. Максимальная длина строки в символах — 50. |
disk | oneof: disk_id или device_name |
disk_id | string Идентификатор диска, который необходимо отсоединить. Максимальная длина строки в символах — 50. |
device_name | string Серийный номер диска, который необходимо отсоединить. На виртуальной машине с операционной системой Linux поиск этого значения будет осуществлен в директории /dev/disk/by-id/. Значение должно соответствовать регулярному выражению [a-z][a-z0-9-_]{,19} . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<DetachInstanceDiskMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Instance> в случае успешного выполнения операции. |
DetachInstanceDiskMetadata
Поле | Описание |
---|---|
instance_id | string Идентификатор виртуальной машины. |
disk_id | string Идентификатор типа диска. |
Instance
Поле | Описание |
---|---|
id | string Идентификатор виртуальной машины. |
folder_id | string Идентификатор каталога, которому принадлежит виртуальная машина. |
created_at | google.protobuf.Timestamp |
name | string Имя виртуальной машины. Длина 1-63 символов. |
description | string Описание виртуальной машины. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате key:value . Максимум 64 на ресурс. |
zone_id | string Идентификатор зоны доступности, где находится виртуальная машина. |
platform_id | string Идентификатор аппаратной платформы виртуальной машины. |
resources | Resources Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. |
status | enum Status Статус виртуальной машины.
|
metadata | map<string,string> Метаданные в формате пар key:value , назначаемые данной виртуальной машине. Сюда входят пользовательские метаданные и предопределенные ключи. Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины. |
boot_disk | AttachedDisk Загрузочный диск, подключенный к виртуальной машине. |
secondary_disks[] | AttachedDisk Массив дополнительных дисков, подключенных к виртуальной машине. |
network_interfaces[] | NetworkInterface Массив сетевых интерфейсов, присоединенных к виртуальной машине. |
fqdn | string Доменное имя виртуальной машины. FQDN определяется сервером в формате <hostname>.<region_id>.internal при создании виртуальной машины. Если имя хоста не было указано при создании виртуальной машины, FQDN будет <id>.auto.internal . |
scheduling_policy | SchedulingPolicy Конфигурация политики планирования. |
service_account_id | string Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос yandex.cloud.iam.v1.ServiceAccountService.List. |
network_settings | NetworkSettings Не указывайте это поле, сетевые настройки пока не поддерживаются. |
Resources
Поле | Описание |
---|---|
memory | int64 Объем памяти в байтах, доступный виртуальной машине. |
cores | int64 Количество ядер, доступное виртуальной машине. |
core_fraction | int64 Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. |
gpus | int64 Количество GPU, доступное виртуальной машине. |
AttachedDisk
Поле | Описание |
---|---|
mode | enum Mode Режим доступа к ресурсу Disk.
|
device_name | string Cерийный номер, который отображается в директории /dev/disk/by-id/ на виртуальной машине с операционной системой Linux. Это значение может использоваться для ссылки на устройство внутри виртуальной машины при монтировании, изменении размера и т. д. |
auto_delete | bool Указывает, должен ли диск автоматически удалиться при удалении виртуальной машины. |
disk_id | string Идентификатор диска, подключенного к виртуальной машине. |
NetworkInterface
Поле | Описание |
---|---|
index | string Индекс сетевого интерфейса, генерируемого сервером, 0,1,2... В настоящее время для каждой виртуальной машины поддерживается только один сетевой интерфейс. |
mac_address | string MAC-адрес, назначенный сетевому интерфейсу. |
subnet_id | string Идентификатор подсети. |
primary_v4_address | PrimaryAddress Основной IPv4-адрес, который назначен виртуальной машине для данного сетевого интерфейса. |
primary_v6_address | PrimaryAddress Основной IPv6-адрес, который назначен виртуальной машине для данного сетевого интерфейса. IPv6 еще не доступен. |
PrimaryAddress
Поле | Описание |
---|---|
address | string Внутренний IPv4-адрес, назначенный виртуальной машине для данного сетевого интерфейса. |
one_to_one_nat | OneToOneNat Конфигурация one-to-one NAT. Если она отсутствует, NAT не был настроен. |
OneToOneNat
Поле | Описание |
---|---|
address | string Публичный IP-адрес, связанный с данной виртуальной машиной. |
ip_version | enum IpVersion Версия IP для публичного IP-адреса.
|
SchedulingPolicy
Поле | Описание |
---|---|
preemptible | bool Если значение равно true — будет создана прерываемая виртуальная машина. Дополнительные сведения см. в разделе Прерываемые виртуальные машины. |
NetworkSettings
Поле | Описание |
---|---|
type | enum Type Не указывайте это поле, сетевые настройки пока не поддерживаются.
|
ListOperations
Возвращает список операций для указанной виртуальной машины.
rpc ListOperations (ListInstanceOperationsRequest) returns (ListInstanceOperationsResponse)
ListInstanceOperationsRequest
Поле | Описание |
---|---|
instance_id | string Обязательное поле. Идентификатор ресурса Instance, для которого запрашивается список операций. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListInstanceOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListInstanceOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListInstanceOperationsResponse
Поле | Описание |
---|---|
operations[] | operation.Operation Список операций для указанной виртуальной машины. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListInstanceOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListInstanceOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response . |