Метод update

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

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"
  },
  "metadata": "object"
}
Поле Описание
updateMask string

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

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

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

name string

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

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

description string

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

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

labels object

Метки ресурса в формате ключ:значение.

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

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

platformId string

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

В настоящее время доступна только одна платформа - "standard-v1`. Эта платформа подходит для большинства задач. Эта платформа позволяет создавать машины различных типов: с большим объемом памяти, с большим количеством ядер, с высокой производительностью.

Значение должно соответствовать регулярному выражению standard-v1.

resourcesSpec object

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

resourcesSpec.
memory
string (int64)

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

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

resourcesSpec.
cores
string (int64)

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

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

resourcesSpec.
coreFraction
string (int64)

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

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

Значение должно быть равно 5.

metadata object

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

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

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

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

Ответ

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.

createdBy string

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

modifiedAt string (date-time)

Только для вывода. Время, когда ресурс Operation последний раз обновлялся. Значение в формате 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.