Подключиться
Yandex Managed Service for Kubernetes

Метод update

Обновляет указанный кластер Kubernetes.

HTTP-запрос

PATCH https://mks.api.cloud.yandex.net/managed-kubernetes/v1/clusters/{clusterId}

Path-параметры

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

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

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "masterSpec": {
    "version": {

      // `masterSpec.version` включает только одно из полей `version`, `latestRevision`
      "version": "string",
      "latestRevision": true,
      // конец списка возможных полей`masterSpec.version`

    },
    "maintenancePolicy": {
      "autoUpgrade": true,
      "maintenanceWindow": {

        // `masterSpec.maintenancePolicy.maintenanceWindow` включает только одно из полей `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
        "anytime": {},
        "dailyMaintenanceWindow": {
          "startTime": {
            "hours": "integer",
            "minutes": "integer",
            "seconds": "integer",
            "nanos": "integer"
          },
          "duration": "string"
        },
        "weeklyMaintenanceWindow": {
          "daysOfWeek": [
            {
              "days": [
                "string"
              ],
              "startTime": {
                "hours": "integer",
                "minutes": "integer",
                "seconds": "integer",
                "nanos": "integer"
              },
              "duration": "string"
            }
          ]
        },
        // конец списка возможных полей`masterSpec.maintenancePolicy.maintenanceWindow`

      }
    }
  },
  "serviceAccountId": "string",
  "nodeServiceAccountId": "string",
  "networkPolicy": {
    "provider": "string"
  },
  "gatewayIpv4Address": "string"
}
Поле Описание
updateMask string

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

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

Имя кластера Kubernetes. Имя должно быть уникальным в каталоге.

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

Описание кластера Kubernetes.

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

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

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

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

Спецификация обновления мастера.
masterSpec.
version.
version		 string
masterSpec.version включает только одно из полей version, latestRevision

Запрос обновления до более новой версии Kubernetes (1.x - > 1.y).
masterSpec.
version.
latestRevision		 boolean (boolean)
masterSpec.version включает только одно из полей version, latestRevision

Запрос минорного обновления, содержащего новую функциональность и улучшения, для текущей версии Kubernetes.
masterSpec.
maintenancePolicy		 object

Политика обновления мастера.
masterSpec.
maintenancePolicy.
autoUpgrade		 boolean (boolean)

Если установлено значение true, автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false, автоматическое обновление отключено.
masterSpec.
maintenancePolicy.
maintenanceWindow		 object

Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.
masterSpec.
maintenancePolicy.
maintenanceWindow.
anytime		 object
Обновление мастера в любое время.
masterSpec.maintenancePolicy.maintenanceWindow включает только одно из полей anytime, dailyMaintenanceWindow, weeklyMaintenanceWindow
masterSpec.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow		 object
Обновление мастера в любой день в течение указанного временного окна.
masterSpec.maintenancePolicy.maintenanceWindow включает только одно из полей anytime, dailyMaintenanceWindow, weeklyMaintenanceWindow
masterSpec.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime		 object

Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.

Время суток. Дата и часовой пояс либо не учитываются, либо задаются в других местах.

API может разрешить использование високосной секунды.

Связанные типы: google.type.Date и google.protobuf.Timestamp.
masterSpec.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
hours		 integer (int32)

Часы. Допустимые значения: от 0 до 23.

API может разрешить использовать значение в формате "24:00:00" в требующих этого сценариях (например, для указания времени закрытия учреждения).
masterSpec.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
minutes		 integer (int32)

Минуты. Допустимые значения: от 0 до 59.
masterSpec.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
seconds		 integer (int32)

Секунды. Стандартные допустимые значения: от 0 до 59.

API может разрешить использовать значение 60, если также разрешено использование високосной секунды.
masterSpec.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
nanos		 integer (int32)

Доли секунды (в наносекундах). Допустимые значения: от 0 до 999999999.
masterSpec.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
duration		 string

Длительность окна обновлений.

Допустимые значения — от 3600 seconds до 86400 seconds включительно.
masterSpec.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow		 object
Обновление мастера в выбранные дни в течение указанного временного окна.
masterSpec.maintenancePolicy.maintenanceWindow включает только одно из полей anytime, dailyMaintenanceWindow, weeklyMaintenanceWindow
masterSpec.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[]		 object

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

Количество элементов должно находиться в диапазоне от 1 до 7.
masterSpec.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
days[]		 string

Represents a day of week.

  • DAY_OF_WEEK_UNSPECIFIED: The unspecified day-of-week.
  • MONDAY: The day-of-week of Monday.
  • TUESDAY: The day-of-week of Tuesday.
  • WEDNESDAY: The day-of-week of Wednesday.
  • THURSDAY: The day-of-week of Thursday.
  • FRIDAY: The day-of-week of Friday.
  • SATURDAY: The day-of-week of Saturday.
  • SUNDAY: The day-of-week of Sunday.
masterSpec.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime		 object

Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.

Время суток. Дата и часовой пояс либо не учитываются, либо задаются в других местах.

API может разрешить использование високосной секунды.

Связанные типы: google.type.Date и google.protobuf.Timestamp.
masterSpec.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
hours		 integer (int32)

Часы. Допустимые значения: от 0 до 23.

API может разрешить использовать значение в формате "24:00:00" в требующих этого сценариях (например, для указания времени закрытия учреждения).
masterSpec.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
minutes		 integer (int32)

Минуты. Допустимые значения: от 0 до 59.
masterSpec.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
seconds		 integer (int32)

Секунды. Стандартные допустимые значения: от 0 до 59.

API может разрешить использовать значение 60, если также разрешено использование високосной секунды.
masterSpec.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
nanos		 integer (int32)

Доли секунды (в наносекундах). Допустимые значения: от 0 до 999999999.
masterSpec.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
duration		 string

Длительность окна обновлений.

Допустимые значения — от 3600 seconds до 86400 seconds включительно.
serviceAccountId string

Сервисный аккаунт, используемый для выделения Compute Cloud и VPC ресурсов для кластера Kubernetes. Выбранный сервисный аккаунт должна иметь edit роль в каталоге, в котором будет расположен кластер Kubernetes, и в каталоге, в котором находится выбранная сеть.
nodeServiceAccountId string

Сервисный аккаунт, используемый узлами кластера Kubernetes для доступа к Container Registry или для загрузки логов и метрик узла.
networkPolicy object
networkPolicy.
provider		 string
gatewayIpv4Address string

Адрес шлюза IPv4.

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

Ответ

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.
В этой статье: