Метод update
Изменяет указанную группу узлов.
HTTP-запрос
PATCH https://mks.api.cloud.yandex.net/managed-kubernetes/v1/nodeGroups/{nodeGroupId}
Path-параметры
Параметр | Описание |
---|---|
nodeGroupId | Обязательное поле. Идентификатор изменяемой группы узлов. Чтобы получить идентификатор группы узлов, используйте запрос list. |
Параметры в теле запроса
{
"updateMask": "string",
"name": "string",
"description": "string",
"labels": "object",
"nodeTemplate": {
"platformId": "string",
"resourcesSpec": {
"memory": "string",
"cores": "string",
"coreFraction": "string"
},
"bootDiskSpec": {
"diskTypeId": "string",
"diskSize": "string"
},
"metadata": "object",
"v4AddressSpec": {
"oneToOneNatSpec": {
"ipVersion": "string"
}
},
"schedulingPolicy": {
"preemptible": true
}
},
"scalePolicy": {
// `scalePolicy` включает только одно из полей `fixedScale`, `autoScale`
"fixedScale": {
"size": "string"
},
"autoScale": {
"minSize": "string",
"maxSize": "string",
"initialSize": "string"
},
// конец списка возможных полей`scalePolicy`
},
"allocationPolicy": {
"locations": [
{
"zoneId": "string",
"subnetId": "string"
}
]
},
"version": {
// `version` включает только одно из полей `version`, `latestRevision`
"version": "string",
"latestRevision": true,
// конец списка возможных полей`version`
},
"maintenancePolicy": {
"autoUpgrade": true,
"autoRepair": true,
"maintenanceWindow": {
// `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"
}
]
},
// конец списка возможных полей`maintenancePolicy.maintenanceWindow`
}
},
"allowedUnsafeSysctls": [
"string"
]
}
Поле | Описание |
---|---|
updateMask | string Маска, определяющая, какие поля группы узлов будут изменены. Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре Если в запросе не передается |
name | string Новое имя группы узлов. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению |
description | string Новое описание группы узлов. Максимальная длина строки в символах — 256. |
labels | object Метки ресурса в формате Существующий набор Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению |
nodeTemplate | object Шаблон узла для создания группы узлов. Изменение может вызвать перезагрузку или повторное создание узлов. |
nodeTemplate. platformId |
string Идентификатор аппаратной платформы виртуальной машины. |
nodeTemplate. resourcesSpec |
object Вычислительные ресурсы узла, такие как объем памяти и количество ядер. |
nodeTemplate. resourcesSpec. memory |
string (int64) Объем памяти в байтах, доступный виртуальной машине. Допустимые значения — от 0 до 274877906944 включительно. |
nodeTemplate. resourcesSpec. cores |
string (int64) Количество ядер, доступное узлу. Значение должно быть равно 0, 1, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30 или 32. |
nodeTemplate. resourcesSpec. coreFraction |
string (int64) Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0, 5, 20, 50 или 100. |
nodeTemplate. bootDiskSpec |
object Спецификация загрузочного диска, который будет подключен к узлу. |
nodeTemplate. bootDiskSpec. diskTypeId |
string Идентификатор типа диска. Значение должно соответствовать регулярному выражению |
nodeTemplate. bootDiskSpec. diskSize |
string (int64) Размер диска в байтах. Допустимые значения — от 0 до 4398046511104 включительно. |
nodeTemplate. metadata |
object Метаданные, назначаемые этому шаблону виртуальной машины, в формате Например, вы можете использовать метаданные для предоставления вашего открытого SSH-ключа узлу. Дополнительные сведения см. в разделе Metadata. Не более 128 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению |
nodeTemplate. v4AddressSpec |
object Спецификация для создания сетевых интерфейсов для вычислительных экземпляров группы узлов. |
nodeTemplate. v4AddressSpec. oneToOneNatSpec |
object Конфигурация one-to-one NAT. Настройка one-to-one NAT гарантирует, что узлам будут назначены публичные IP-адреса. Поэтому интернет будет доступен на всех узлах группы узлов. Если поле не задано, NAT не будет настроен. |
nodeTemplate. v4AddressSpec. oneToOneNatSpec. ipVersion |
string Версия IP для публичного IP-адреса.
|
nodeTemplate. schedulingPolicy |
object Политика планирования. |
nodeTemplate. schedulingPolicy. preemptible |
boolean (boolean) Если значение равно |
scalePolicy | object Политика масштабирования группы узлов. |
scalePolicy. fixedScale |
object Политика масштабирования группы узлов. scalePolicy включает только одно из полей fixedScale , autoScale |
scalePolicy. fixedScale. size |
string (int64) Количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
scalePolicy. autoScale |
object Политика масштабирования группы узлов. scalePolicy включает только одно из полей fixedScale , autoScale |
scalePolicy. autoScale. minSize |
string (int64) Минимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
scalePolicy. autoScale. maxSize |
string (int64) Максимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно. |
scalePolicy. autoScale. initialSize |
string (int64) Начальный размер группы узлов. Допустимые значения — от 0 до 100 включительно. |
allocationPolicy | object Политика распределения группы узлов по зонам и регионам. |
allocationPolicy. locations[] |
object Список местоположений (зон доступности и подсетей), в которых будут выделены ресурсы для группы узлов. |
allocationPolicy. locations[]. zoneId |
string Обязательное поле. Идентификатор зоны доступности, в которой могут находиться узлы. |
allocationPolicy. locations[]. subnetId |
string Идентификатор подсети. Если сеть, выбранная для кластера Kubernetes, имеет только одну подсеть в указанной зоне, идентификатор подсети может быть опущен. |
version | object Версия компонентов Kubernetes, которая запущена на узлах. |
version. version |
string version включает только одно из полей version , latestRevision Запрос обновления до более новой версии Kubernetes (1.x - > 1.y). |
version. latestRevision |
boolean (boolean) version включает только одно из полей version , latestRevision Запрос минорного обновления, содержащего новую функциональность и улучшения, для текущей версии Kubernetes. |
maintenancePolicy | object Политика обновления группы узлов. |
maintenancePolicy. autoUpgrade |
boolean (boolean) Если установлено значение |
maintenancePolicy. autoRepair |
boolean (boolean) Если установлено значение |
maintenancePolicy. maintenanceWindow |
object Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC. |
maintenancePolicy. maintenanceWindow. anytime |
object Обновление мастера в любое время. maintenancePolicy.maintenanceWindow включает только одно из полей anytime , dailyMaintenanceWindow , weeklyMaintenanceWindow |
maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow |
object Обновление мастера в любой день в течение указанного временного окна. maintenancePolicy.maintenanceWindow включает только одно из полей anytime , dailyMaintenanceWindow , weeklyMaintenanceWindow |
maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime |
object Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. Время суток. Дата и часовой пояс либо не учитываются, либо задаются в других местах. API может разрешить использование високосной секунды. Связанные типы: google.type.Date и google.protobuf.Timestamp. |
maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. hours |
integer (int32) Часы. Допустимые значения: от 0 до 23. API может разрешить использовать значение в формате "24:00:00" в требующих этого сценариях (например, для указания времени закрытия учреждения). |
maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. minutes |
integer (int32) Минуты. Допустимые значения: от 0 до 59. |
maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. seconds |
integer (int32) Секунды. Стандартные допустимые значения: от 0 до 59. API может разрешить использовать значение 60, если также разрешено использование високосной секунды. |
maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. nanos |
integer (int32) Доли секунды (в наносекундах). Допустимые значения: от 0 до 999999999. |
maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. duration |
string Длительность окна обновлений. Допустимые значения — от 3600 seconds до 86400 seconds включительно. |
maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow |
object Обновление мастера в выбранные дни в течение указанного временного окна. maintenancePolicy.maintenanceWindow включает только одно из полей anytime , dailyMaintenanceWindow , weeklyMaintenanceWindow |
maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[] |
object Обязательное поле. Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7. |
maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. days[] |
string Represents a day of week.
|
maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime |
object Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. Время суток. Дата и часовой пояс либо не учитываются, либо задаются в других местах. API может разрешить использование високосной секунды. Связанные типы: google.type.Date и google.protobuf.Timestamp. |
maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. hours |
integer (int32) Часы. Допустимые значения: от 0 до 23. API может разрешить использовать значение в формате "24:00:00" в требующих этого сценариях (например, для указания времени закрытия учреждения). |
maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. minutes |
integer (int32) Минуты. Допустимые значения: от 0 до 59. |
maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. seconds |
integer (int32) Секунды. Стандартные допустимые значения: от 0 до 59. API может разрешить использовать значение 60, если также разрешено использование високосной секунды. |
maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. nanos |
integer (int32) Доли секунды (в наносекундах). Допустимые значения: от 0 до 999999999. |
maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. duration |
string Длительность окна обновлений. Допустимые значения — от 3600 seconds до 86400 seconds включительно. |
allowedUnsafeSysctls[] | string Поддержка параметров unsafe sysctl. Дополнительные сведения см. в документации. |
Ответ
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) Если значение равно |
metadata | object Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля |
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, в описании метода приведена структура соответствующего ему поля |