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

Метод update

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

Изменяет указанную виртуальную машину.

HTTP-запрос

PATCH https://compute.api.cloud.yandex.net/compute/v1/instances/{instanceId}

Path-параметры

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

Параметры в теле запроса

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "platformId": "string",
  "resourcesSpec": {
    "memory": "string",
    "cores": "string",
    "coreFraction": "string",
    "gpus": "string"
  },
  "metadata": "object",
  "serviceAccountId": "string",
  "networkSettings": {
    "type": "string"
  }
}
Поле Описание
updateMask string

Маска, определяющая, какие поля ресурса Disk будут обновлены.

Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре updateMask и в запросе не было отправлено значение для этого поля, значение поля будет сброшено на значение по умолчанию. Значение по умолчанию для большинства полей — null или 0.

Если в запросе не передается updateMask, значения всех полей будут обновлены. Для полей, указанных в запросе, будут использованы переданные значения. Значения остальных полей будут сброшены на значения по умолчанию.

name string

Имя виртуальной машины.

Значение должно соответствовать регулярному выражению \|[a-z][-a-z0-9]{1,61}[a-z0-9].

description string

Описание виртуальной машины.

Максимальная длина строки в символах — 256.

labels object

Метки ресурса в формате key:value.

Существующий набор labels полностью перезаписывается набором, переданным в запросе.

Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*.

platformId string

Идентификатор аппаратной платформы виртуальной машины. Это поле влияет на допустимые значения поля resourcesSpec.

Платформы позволяют создавать виртуальные машины разных типов: с большим объемом памяти, с большим количеством ядер или с высокой производительностью. Дополнительные сведения см. в разделе Платформы.

resourcesSpec object

Вычислительные ресурсы виртуальной машины, такие как объем памяти и количество ядер. Чтобы узнать список допустимых значений, см. раздел Уровни производительности vCPU.

resourcesSpec.
memory
string (int64)

Обязательное поле. Объем памяти в байтах, доступный виртуальной машине.

Максимальное значение — 274877906944.

resourcesSpec.
cores
string (int64)

Обязательное поле. Количество ядер, доступное виртуальной машине.

Значение должно быть равно 1, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30 или 32.

resourcesSpec.
coreFraction
string (int64)

Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра.

Например, если требуется только 5% производительности CPU, можно задать значение core_fraction=5. Дополнительные сведения см. в разделе Уровни производительности vCPU.

Значение должно быть равно 0, 5, 20, 50 или 100.

resourcesSpec.
gpus
string (int64)

Количество GPU, доступное виртуальной машине.

Значение должно быть равно 0, 1, 2 или 4.

metadata object

Метаданные, назначаемые данной виртуальной машине, в формате пар ключ:значение. Сюда входят пользовательские метаданные и предопределенные ключи. Общий размер всех ключей и значений не должен превышать 512 КБ.

Существующий набор metadata полностью перезаписывается набором, переданным в запросе.

Значениями являются строки и используются только программами, которые настраивают виртуальную машину. Значения должны быть не более 256 КБ.

Например, можно использовать метаданные для доставки открытого ключа SSH на виртуальную машину. Дополнительные сведения см. в разделе Метаданные виртуальной машины.

serviceAccountId string

Идентификатор сервисного аккаунта для аутентификации изнутри виртуальной машины. Чтобы получить идентификатор сервисного аккаунта, используйте запрос list.

networkSettings object

Сетевые настройки.

networkSettings.
type
string

Не указывайте это поле, сетевые настройки пока не поддерживаются.

  • STANDARD: Стандартная сеть.
  • SOFTWARE_ACCELERATED: Сеть с программным ускорением.
  • HARDWARE_ACCELERATED: Сеть с аппаратным ускорением (этот тип пока недоступен, значение зарезервировано для использования в будущем).

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе
Объект Operation.

Поле Описание
id string

Идентификатор операции.

description string

Описание операции. Длина описания должна быть от 0 до 256 символов.

createdAt string (date-time)

Время создания ресурса в формате в RFC3339.

Строка в формате RFC3339.

createdBy string

Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.

modifiedAt string (date-time)

Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.

Строка в формате RFC3339.

done boolean (boolean)

Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.

metadata object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.

error object
Описание ошибки в случае сбоя или отмены операции.
включает только одно из полей error, response

Описание ошибки в случае сбоя или отмены операции.

error.
code
integer (int32)

Код ошибки. Значение из списка google.rpc.Code.

error.
message
string

Текст ошибки.

error.
details[]
object

Список сообщений с подробными сведениями об ошибке.

response object
включает только одно из полей error, response

Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.

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