Метод update

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

Обновляет конфигурацию указанного кластера.

HTTP-запрос

PATCH https://dataproc.api.cloud.yandex.net/dataproc/v1/clusters/{clusterId}

Path-параметры

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

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

{
  "updateMask": "string",
  "description": "string",
  "labels": "object",
  "configSpec": {
    "subclustersSpec": [
      {
        "id": "string",
        "name": "string",
        "resources": {
          "resourcePresetId": "string",
          "diskTypeId": "string",
          "diskSize": "string"
        },
        "hostsCount": "string"
      }
    ]
  },
  "name": "string",
  "serviceAccountId": "string",
  "bucket": "string"
}

Поле	Описание
updateMask	string Маска поля, которая указывает, какие атрибуты кластера должны быть изменены. Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре `updateMask` и в запросе не было отправлено значение для этого поля, значение поля будет сброшено на значение по умолчанию. Значение по умолчанию для большинства полей — null или 0. Если в запросе не передается `updateMask`, значения всех полей будут обновлены. Для полей, указанных в запросе, будут использованы переданные значения. Значения остальных полей будут сброшены на значения по умолчанию.
description	string Новое описание кластера. Максимальная длина строки в символах — 256.
labels	object Новый набор меток кластера в виде пар `ключ: значение`. Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению `[a-z][-_0-9a-z]`. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению `[-_0-9a-z]`.
configSpec	object Конфигурация и ресурсы хостов, которые должны быть созданы для кластера Data Proc.
configSpec. subclustersSpec[]	object Новая конфигурация для подкластеров в кластере.
configSpec. subclustersSpec[]. id	string Идентификатор подкластера, который следует изменить. Чтобы получить идентификатор подкластера, используйте запрос list.
configSpec. subclustersSpec[]. name	string Имя подкластера. Значение должно соответствовать регулярному выражению `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`.
configSpec. subclustersSpec[]. resources	object Конфигурация ресурсов для каждого хоста в подкластере.
configSpec. subclustersSpec[]. resources. resourcePresetId	string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
configSpec. subclustersSpec[]. resources. diskTypeId	string Тип хранилища для хоста. Возможные значения: network-hdd — сетевой HDD-диск; network-ssd — сетевой SSD-диск.
configSpec. subclustersSpec[]. resources. diskSize	string (int64) Объем хранилища, доступного хосту, в байтах.
configSpec. subclustersSpec[]. hostsCount	string (int64) Количество хостов в подкластере. Минимальное значение — 1.
name	string Новое имя кластера Data Proc. Имя должно быть уникальным в рамках каталога. Значение должно соответствовать регулярному выражению `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`.
serviceAccountId	string Идентификатор сервисного аккаунта, которым должен пользоваться агент Data Proc для управления задачами.
bucket	string Имя нового бакета Object Storage, который следует использовать для задач Data Proc.

Ответ

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`.