Managed Services for Kubernetes API, REST: NodeGroup.Update

Written by

Updated at April 13, 2026

HTTP request
Path parameters
Body parameters
NodeTemplate
ResourcesSpec
DiskSpec
NodeAddressSpec
OneToOneNatSpec
DnsRecordSpec
SchedulingPolicy
NetworkInterfaceSpec
PlacementPolicy
NetworkSettings
ContainerRuntimeSettings
ContainerNetworkSettings
GpuSettings
ScalePolicy
FixedScale
AutoScale
NodeGroupAllocationPolicy
NodeGroupLocation
DeployPolicy
UpdateVersionSpec
NodeGroupMaintenancePolicy
MaintenanceWindow
DailyMaintenanceWindow
TimeOfDay
WeeklyMaintenanceWindow
DaysOfWeekMaintenanceWindow
Taint
Variable
NodeGroupWorkloadIdentityFederation
Response
UpdateNodeGroupMetadata
Status
NodeGroup
NodeTemplate
ResourcesSpec
DiskSpec
NodeAddressSpec
OneToOneNatSpec
DnsRecordSpec
SchedulingPolicy
NetworkInterfaceSpec
PlacementPolicy
NetworkSettings
ContainerRuntimeSettings
ContainerNetworkSettings
GpuSettings
ScalePolicy
FixedScale
AutoScale
NodeGroupAllocationPolicy
NodeGroupLocation
DeployPolicy
VersionInfo
NodeGroupMaintenancePolicy
MaintenanceWindow
DailyMaintenanceWindow
TimeOfDay
WeeklyMaintenanceWindow
DaysOfWeekMaintenanceWindow
Taint
Variable
NodeGroupWorkloadIdentityFederation

Updates the specified node group.

HTTP request

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

Path parameters

Field

Description

nodeGroupId

string

Required field. ID of the node group to update.
To get the node group ID use a NodeGroupService.List request.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "nodeTemplate": {
    "name": "string",
    "labels": "object",
    "platformId": "string",
    "resourcesSpec": {
      "memory": "string",
      "cores": "string",
      "coreFraction": "string",
      "gpus": "string"
    },
    "bootDiskSpec": {
      "diskTypeId": "string",
      "diskSize": "string"
    },
    "reservedInstancePoolId": "string",
    "metadata": "object",
    "v4AddressSpec": {
      "oneToOneNatSpec": {
        "ipVersion": "string"
      },
      "dnsRecordSpecs": [
        {
          "fqdn": "string",
          "dnsZoneId": "string",
          "ttl": "string",
          "ptr": "boolean"
        }
      ]
    },
    "schedulingPolicy": {
      "preemptible": "boolean"
    },
    "networkInterfaceSpecs": [
      {
        "subnetIds": [
          "string"
        ],
        "primaryV4AddressSpec": {
          "oneToOneNatSpec": {
            "ipVersion": "string"
          },
          "dnsRecordSpecs": [
            {
              "fqdn": "string",
              "dnsZoneId": "string",
              "ttl": "string",
              "ptr": "boolean"
            }
          ]
        },
        "primaryV6AddressSpec": {
          "oneToOneNatSpec": {
            "ipVersion": "string"
          },
          "dnsRecordSpecs": [
            {
              "fqdn": "string",
              "dnsZoneId": "string",
              "ttl": "string",
              "ptr": "boolean"
            }
          ]
        },
        "securityGroupIds": [
          "string"
        ]
      }
    ],
    "placementPolicy": {
      "placementGroupId": "string"
    },
    "networkSettings": {
      "type": "string"
    },
    "containerRuntimeSettings": {
      "type": "string"
    },
    "containerNetworkSettings": {
      "podMtu": "string"
    },
    "gpuSettings": {
      "gpuClusterId": "string",
      "gpuEnvironment": "string"
    }
  },
  "scalePolicy": {
    // Includes only one of the fields `fixedScale`, `autoScale`
    "fixedScale": {
      "size": "string"
    },
    "autoScale": {
      "minSize": "string",
      "maxSize": "string",
      "initialSize": "string"
    }
    // end of the list of possible fields
  },
  "allocationPolicy": {
    "locations": [
      {
        "zoneId": "string",
        "subnetId": "string"
      }
    ]
  },
  "deployPolicy": {
    "maxUnavailable": "string",
    "maxExpansion": "string"
  },
  "version": {
    // Includes only one of the fields `version`, `latestRevision`
    "version": "string",
    "latestRevision": "boolean"
    // end of the list of possible fields
  },
  "maintenancePolicy": {
    "autoUpgrade": "boolean",
    "autoRepair": "boolean",
    "maintenanceWindow": {
      // Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
      "anytime": "object",
      "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"
          }
        ]
      }
      // end of the list of possible fields
    }
  },
  "allowedUnsafeSysctls": [
    "string"
  ],
  "nodeTaints": [
    {
      "key": "string",
      "value": "string",
      "effect": "string"
    }
  ],
  "nodeLabels": "object",
  "variables": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "workloadIdentityFederation": {
    "enabled": "boolean"
  }
}

Field	Description
updateMask	string (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string Name of the node group. The name must be unique within the folder. Value must match the regular expression `\|[a-z]([-a-z0-9]{0,61}[a-z0-9])?`.
description	string Description of the node group. The maximum string length in characters is 256.
labels	object (map<string, string>) Resource labels as `key:value` pairs. Existing set of `labels` is completely replaced by the provided set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression `[-_./\@0-9a-z]`. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_./\@0-9a-z]`.
nodeTemplate	NodeTemplate Node template for the node group. Change may trigger nodes rolling reboot or recreate.
scalePolicy	ScalePolicy Scale policy of the node group.
allocationPolicy	NodeGroupAllocationPolicy Allocation policy of the node group by the zones and regions.
deployPolicy	DeployPolicy Deploy policy according to which the updates are rolled out. If not specified, the default is used.
version	UpdateVersionSpec Version of Kubernetes components that runs on the nodes.
maintenancePolicy	NodeGroupMaintenancePolicy Maintenance policy of the node group.
allowedUnsafeSysctls[]	string Support for unsafe sysctl parameters. For more details see documentation. The maximum string length in characters for each value is 253. Each value must match the regular expression `([a-z0-9]([-_a-z0-9][a-z0-9])?\.)([a-z0-9][-_a-z0-9])?[a-z0-9]`.
nodeTaints[]	Taint Taints that are applied to the nodes of the node group at creation time.
nodeLabels	object (map<string, string>) Labels that are assigned to the nodes of the node group at creation time.
variables[]	Variable Variables for templating.
workloadIdentityFederation	NodeGroupWorkloadIdentityFederation Workload Identity Federation parameters of the node group.

NodeTemplate

Field	Description
name	string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128.
labels	object (map<string, string>) these labels will be assigned to compute nodes (instances), created by the nodegroup No more than 32 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_./\@0-9a-z]*`.
platformId	string ID of the hardware platform configuration for the node.
resourcesSpec	ResourcesSpec Computing resources of the node such as the amount of memory and number of cores.
bootDiskSpec	DiskSpec Specification for the boot disk that will be attached to the node.
reservedInstancePoolId	string ID of the reserved instance pool.
metadata	object (map<string, string>) The metadata as `key:value` pairs assigned to this instance template. Only SSH keys are supported as metadata. For more information, see Connecting to a node over SSH. No more than 64 per resource. The maximum string length in characters for each value is 131072. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_0-9a-z]*`.
v4AddressSpec	NodeAddressSpec Specification for the create network interfaces for the node group compute instances. Deprecated, please use network_interface_specs.
schedulingPolicy	SchedulingPolicy Scheduling policy configuration.
networkInterfaceSpecs[]	NetworkInterfaceSpec New api, to specify network interfaces for the node group compute instances. Can not be used together with 'v4_address_spec'
placementPolicy	PlacementPolicy Placement policy configuration that controls physical placement of node group instances in the cloud infrastructure for optimizing performance and reliability.
networkSettings	NetworkSettings this parameter allows to specify type of network acceleration used on nodes (instances)
containerRuntimeSettings	ContainerRuntimeSettings Container runtime settings for the node template.
containerNetworkSettings	ContainerNetworkSettings Container network settings for the node template.
gpuSettings	GpuSettings GPU settings

ResourcesSpec

Field	Description
memory	string (int64) Amount of memory available to the node, specified in bytes. The minimum value is 0.
cores	string (int64) Number of cores available to the node. The minimum value is 0.
coreFraction	string (int64) Baseline level of CPU performance with the possibility to burst performance above that baseline level. This field sets baseline performance for each core. Acceptable values are 0 to 100, inclusive.
gpus	string (int64) Number of GPUs available to the node. The minimum value is 0.

DiskSpec

Field

Description

diskTypeId

string

ID of the disk type.

Value must match the regular expression |network-ssd|network-hdd|network-ssd-nonreplicated|network-ssd-io-m3.

diskSize

string (int64)

Size of the disk, specified in bytes.

Acceptable values are 0 to 4398046511104, inclusive.

NodeAddressSpec

Field

Description

oneToOneNatSpec

OneToOneNatSpec

One-to-one NAT configuration. Setting up one-to-one NAT ensures that public IP addresses are assigned to nodes, and therefore internet is accessible for all nodes of the node group. If the field is not set, NAT will not be set up.

dnsRecordSpecs[]

DnsRecordSpec

Internal DNS configuration.

OneToOneNatSpec

Field

Description

ipVersion

enum (IpVersion)

IP version for the public IP address.

IPV4: IPv4 address, for example 192.168.0.0.
IPV6: IPv6 address, not available yet.

DnsRecordSpec

Field	Description
fqdn	string Required field. FQDN (required).
dnsZoneId	string DNS zone id (optional, if not set, private zone is used).
ttl	string (int64) DNS record ttl, values in 0-86400 (optional). Acceptable values are 0 to 86400, inclusive.
ptr	boolean When set to true, also create PTR DNS record (optional).

SchedulingPolicy

Field

Description

preemptible

boolean

True for preemptible compute instances. Default value is false. Preemptible compute instances are stopped at least once every 24 hours, and can be stopped at any time
if their resources are needed by Compute.
For more information, see Preemptible Virtual Machines.

NetworkInterfaceSpec

Field	Description
subnetIds[]	string IDs of the subnets.
primaryV4AddressSpec	NodeAddressSpec Primary IPv4 address that is assigned to the instance for this network interface.
primaryV6AddressSpec	NodeAddressSpec Primary IPv6 address that is assigned to the instance for this network interface.
securityGroupIds[]	string IDs of security groups.

PlacementPolicy

Field

Description

placementGroupId

string

Identifier of placement group

NetworkSettings

Field

Description

type

enum (Type)

Required field. Network type that specifies the network configuration for the node group instances.

STANDARD: Standard network.
SOFTWARE_ACCELERATED: Software accelerated network.

ContainerRuntimeSettings

Field

Description

type

enum (Type)

Required field. Type of container runtime.

DOCKER: Docker container runtime.
CONTAINERD: Containerd container runtime.

ContainerNetworkSettings

Field

Description

podMtu

string (int64)

MTU (Maximum Transmission Unit) size for pod network interfaces.

GpuSettings

Field

Description

gpuClusterId

string

GPU cluster id, that mk8s node will join.

gpuEnvironment

enum (GpuEnvironment)

GPU environment configured on node.

RUNC_DRIVERS_CUDA: Use a node image with the pre-installed GPU toolkit, drivers and CUDA.
RUNC: Use a node image with the pre-installed GPU toolkit but without drivers.
You should install drivers on a node yourself in that case.
There are tools to help you to do that, for example gpu-operator.

ScalePolicy

Field

Description

fixedScale

FixedScale

Fixed scale policy of the node group.

Includes only one of the fields fixedScale, autoScale.

autoScale

AutoScale

Auto scale policy of the node group.

Includes only one of the fields fixedScale, autoScale.

FixedScale

Field

Description

size

string (int64)

Number of nodes in the node group.

Acceptable values are 0 to 100, inclusive.

AutoScale

Field	Description
minSize	string (int64) Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
maxSize	string (int64) Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
initialSize	string (int64) Initial number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

NodeGroupAllocationPolicy

Field

Description

locations[]

NodeGroupLocation

List of locations where resources for the node group will be allocated.

NodeGroupLocation

Field

Description

zoneId

string

Required field. ID of the availability zone where the nodes may reside.

subnetId

string

ID of the subnet. If a network chosen for the Kubernetes cluster has only one subnet in the specified zone, subnet ID may be omitted.

DeployPolicy

Field

Description

maxUnavailable

string (int64)

The maximum number of running instances that can be taken offline (i.e.,
stopped or deleted) at the same time during the update process.
If maxExpansion is not specified or set to zero, maxUnavailable must
be set to a non-zero value.

Acceptable values are 0 to 100, inclusive.

maxExpansion

string (int64)

The maximum number of instances that can be temporarily allocated above
the group's target size during the update process.
If maxUnavailable is not specified or set to zero, maxExpansion must
be set to a non-zero value.

Acceptable values are 0 to 100, inclusive.

UpdateVersionSpec

Field

Description

version

string

Request update to a newer version of Kubernetes (1.x -> 1.y).

Includes only one of the fields version, latestRevision.

latestRevision

boolean

Request update to the latest revision for the current version.

Includes only one of the fields version, latestRevision.

NodeGroupMaintenancePolicy

Field	Description
autoUpgrade	boolean If set to true, automatic updates are installed in the specified period of time with no interaction from the user. If set to false, automatic upgrades are disabled.
autoRepair	boolean If set to true, automatic repairs are enabled. Default value is false.
maintenanceWindow	MaintenanceWindow Maintenance window settings. Update will start at the specified time and last no more than the specified duration. The time is set in UTC.

MaintenanceWindow

Field	Description
anytime	object Updating the master at any time. Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`. Maintenance policy.
dailyMaintenanceWindow	DailyMaintenanceWindow Updating the master on any day during the specified time window. Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`. Maintenance policy.
weeklyMaintenanceWindow	WeeklyMaintenanceWindow Updating the master on selected days during the specified time window. Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`. Maintenance policy.

DailyMaintenanceWindow

Field

Description

startTime

TimeOfDay

Required field. Window start time, in the UTC timezone.

duration

string (duration)

Window duration.

TimeOfDay

Represents a time of day. The date and time zone are either not significant
or are specified elsewhere. An API may choose to allow leap seconds. Related
types are google.type.Date and google.protobuf.Timestamp.

Field	Description
hours	integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
seconds	integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

WeeklyMaintenanceWindow

Field

Description

daysOfWeek[]

DaysOfWeekMaintenanceWindow

Days of the week and the maintenance window for these days when automatic updates are allowed.

The number of elements must be in the range 1-7.

DaysOfWeekMaintenanceWindow

Field	Description
days[]	enum (DayOfWeek) Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7. `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.
startTime	TimeOfDay Required field. Window start time, in the UTC timezone.
duration	string (duration) Window duration.

Taint

Field	Description
key	string The taint key to be applied to a node.
value	string The taint value corresponding to the taint key.
effect	enum (Effect) The effect of the taint on pods that do not tolerate the taint. `NO_SCHEDULE`: Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. `PREFER_NO_SCHEDULE`: Like NO_SCHEDULE, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler. `NO_EXECUTE`: Evict any already-running pods that do not tolerate the taint.

Variable

Variable is a user-defined key-value pair used for templating.

Field

Description

key

string

Variable name.
Must be unique within the node group.

The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]*.

value

string

Variable value.

The maximum string length in characters is 262144.

NodeGroupWorkloadIdentityFederation

NodeGroupWorkloadIdentityFederation contains configuration for Workload Identity Federation.

Field

Description

enabled

boolean

Identifies whether Workload Identity Federation is enabled.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "nodeGroupId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "clusterId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "object",
    "status": "string",
    "nodeTemplate": {
      "name": "string",
      "labels": "object",
      "platformId": "string",
      "resourcesSpec": {
        "memory": "string",
        "cores": "string",
        "coreFraction": "string",
        "gpus": "string"
      },
      "bootDiskSpec": {
        "diskTypeId": "string",
        "diskSize": "string"
      },
      "reservedInstancePoolId": "string",
      "metadata": "object",
      "v4AddressSpec": {
        "oneToOneNatSpec": {
          "ipVersion": "string"
        },
        "dnsRecordSpecs": [
          {
            "fqdn": "string",
            "dnsZoneId": "string",
            "ttl": "string",
            "ptr": "boolean"
          }
        ]
      },
      "schedulingPolicy": {
        "preemptible": "boolean"
      },
      "networkInterfaceSpecs": [
        {
          "subnetIds": [
            "string"
          ],
          "primaryV4AddressSpec": {
            "oneToOneNatSpec": {
              "ipVersion": "string"
            },
            "dnsRecordSpecs": [
              {
                "fqdn": "string",
                "dnsZoneId": "string",
                "ttl": "string",
                "ptr": "boolean"
              }
            ]
          },
          "primaryV6AddressSpec": {
            "oneToOneNatSpec": {
              "ipVersion": "string"
            },
            "dnsRecordSpecs": [
              {
                "fqdn": "string",
                "dnsZoneId": "string",
                "ttl": "string",
                "ptr": "boolean"
              }
            ]
          },
          "securityGroupIds": [
            "string"
          ]
        }
      ],
      "placementPolicy": {
        "placementGroupId": "string"
      },
      "networkSettings": {
        "type": "string"
      },
      "containerRuntimeSettings": {
        "type": "string"
      },
      "containerNetworkSettings": {
        "podMtu": "string"
      },
      "gpuSettings": {
        "gpuClusterId": "string",
        "gpuEnvironment": "string"
      }
    },
    "scalePolicy": {
      // Includes only one of the fields `fixedScale`, `autoScale`
      "fixedScale": {
        "size": "string"
      },
      "autoScale": {
        "minSize": "string",
        "maxSize": "string",
        "initialSize": "string"
      }
      // end of the list of possible fields
    },
    "allocationPolicy": {
      "locations": [
        {
          "zoneId": "string",
          "subnetId": "string"
        }
      ]
    },
    "deployPolicy": {
      "maxUnavailable": "string",
      "maxExpansion": "string"
    },
    "instanceGroupId": "string",
    "nodeVersion": "string",
    "versionInfo": {
      "currentVersion": "string",
      "newRevisionAvailable": "boolean",
      "newRevisionSummary": "string",
      "versionDeprecated": "boolean"
    },
    "maintenancePolicy": {
      "autoUpgrade": "boolean",
      "autoRepair": "boolean",
      "maintenanceWindow": {
        // Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
        "anytime": "object",
        "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"
            }
          ]
        }
        // end of the list of possible fields
      }
    },
    "allowedUnsafeSysctls": [
      "string"
    ],
    "nodeTaints": [
      {
        "key": "string",
        "value": "string",
        "effect": "string"
      }
    ],
    "nodeLabels": "object",
    "variables": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "workloadIdentityFederation": {
      "enabled": "boolean"
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	UpdateNodeGroupMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	NodeGroup The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

UpdateNodeGroupMetadata

Field

Description

nodeGroupId

string

Required field. ID of the Node group that is being updated.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

NodeGroup

Field	Description
id	string ID of the node group.
clusterId	string ID of the cluster that the node group belongs to.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
name	string Name of the node group. The name is unique within the folder.
description	string Description of the node group. 0-256 characters long.
labels	object (map<string, string>) Resource labels as `key:value` pairs. Maximum of 64 per resource.
status	enum (Status) Status of the node group. `PROVISIONING`: Node group is waiting for resources to be allocated. `RUNNING`: Node group is running. `RECONCILING`: Node group is waiting for some work to be done, such as upgrading node software. `STOPPING`: Node group is being stopped. `STOPPED`: Node group stopped. `DELETING`: Node group is being deleted. `STARTING`: Node group is being started.
nodeTemplate	NodeTemplate Node template that specifies parameters of the compute instances for the node group.
scalePolicy	ScalePolicy Scale policy of the node group. For more information, see Scaling policy.
allocationPolicy	NodeGroupAllocationPolicy Allocation policy by which resources for node group are allocated to zones and regions.
deployPolicy	DeployPolicy Deploy policy according to which the updates are rolled out.
instanceGroupId	string ID of the managed instance group associated with this node group.
nodeVersion	string Version of Kubernetes components that runs on the nodes. Deprecated. Use version_info.current_version.
versionInfo	VersionInfo Detailed information about the Kubernetes version that is running on the node.
maintenancePolicy	NodeGroupMaintenancePolicy Maintenance policy of the node group.
allowedUnsafeSysctls[]	string Support for unsafe sysctl parameters. For more details see documentation.
nodeTaints[]	Taint Taints that are applied to the nodes of the node group at creation time. The `nodeTaints` field is not supported for the yandex.cloud.k8s.v1.NodeGroupService.Update request.
nodeLabels	object (map<string, string>) Labels that are assigned to the nodes of the node group at creation time.
variables[]	Variable User-defined variables for templating.
workloadIdentityFederation	NodeGroupWorkloadIdentityFederation Workload Identity Federation parameters of the node group.

NodeTemplate

Field	Description
name	string Name of the instance. In order to be unique it must contain at least on of instance unique placeholders: {instance.short_id} {instance.index} combination of {instance.zone_id} and {instance.index_in_zone} Example: my-instance-{instance.index} If not set, default is used: {instance_group.id}-{instance.short_id} It may also contain another placeholders, see metadata doc for full list. The maximum string length in characters is 128.
labels	object (map<string, string>) these labels will be assigned to compute nodes (instances), created by the nodegroup No more than 32 per resource. The maximum string length in characters for each value is 128. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_./\@0-9a-z]*`.
platformId	string ID of the hardware platform configuration for the node.
resourcesSpec	ResourcesSpec Computing resources of the node such as the amount of memory and number of cores.
bootDiskSpec	DiskSpec Specification for the boot disk that will be attached to the node.
reservedInstancePoolId	string ID of the reserved instance pool.
metadata	object (map<string, string>) The metadata as `key:value` pairs assigned to this instance template. Only SSH keys are supported as metadata. For more information, see Connecting to a node over SSH. No more than 64 per resource. The maximum string length in characters for each value is 131072. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_0-9a-z]*`.
v4AddressSpec	NodeAddressSpec Specification for the create network interfaces for the node group compute instances. Deprecated, please use network_interface_specs.
schedulingPolicy	SchedulingPolicy Scheduling policy configuration.
networkInterfaceSpecs[]	NetworkInterfaceSpec New api, to specify network interfaces for the node group compute instances. Can not be used together with 'v4_address_spec'
placementPolicy	PlacementPolicy Placement policy configuration that controls physical placement of node group instances in the cloud infrastructure for optimizing performance and reliability.
networkSettings	NetworkSettings this parameter allows to specify type of network acceleration used on nodes (instances)
containerRuntimeSettings	ContainerRuntimeSettings Container runtime settings for the node template.
containerNetworkSettings	ContainerNetworkSettings Container network settings for the node template.
gpuSettings	GpuSettings GPU settings

ResourcesSpec

Field	Description
memory	string (int64) Amount of memory available to the node, specified in bytes. The minimum value is 0.
cores	string (int64) Number of cores available to the node. The minimum value is 0.
coreFraction	string (int64) Baseline level of CPU performance with the possibility to burst performance above that baseline level. This field sets baseline performance for each core. Acceptable values are 0 to 100, inclusive.
gpus	string (int64) Number of GPUs available to the node. The minimum value is 0.

DiskSpec

Field

Description

diskTypeId

string

ID of the disk type.

Value must match the regular expression |network-ssd|network-hdd|network-ssd-nonreplicated|network-ssd-io-m3.

diskSize

string (int64)

Size of the disk, specified in bytes.

Acceptable values are 0 to 4398046511104, inclusive.

NodeAddressSpec

Field

Description

oneToOneNatSpec

OneToOneNatSpec

dnsRecordSpecs[]

DnsRecordSpec

Internal DNS configuration.

OneToOneNatSpec

Field

Description

ipVersion

enum (IpVersion)

IP version for the public IP address.

IPV4: IPv4 address, for example 192.168.0.0.
IPV6: IPv6 address, not available yet.

DnsRecordSpec

Field	Description
fqdn	string Required field. FQDN (required).
dnsZoneId	string DNS zone id (optional, if not set, private zone is used).
ttl	string (int64) DNS record ttl, values in 0-86400 (optional). Acceptable values are 0 to 86400, inclusive.
ptr	boolean When set to true, also create PTR DNS record (optional).

SchedulingPolicy

Field

Description

preemptible

boolean

NetworkInterfaceSpec

Field	Description
subnetIds[]	string IDs of the subnets.
primaryV4AddressSpec	NodeAddressSpec Primary IPv4 address that is assigned to the instance for this network interface.
primaryV6AddressSpec	NodeAddressSpec Primary IPv6 address that is assigned to the instance for this network interface.
securityGroupIds[]	string IDs of security groups.

PlacementPolicy

Field

Description

placementGroupId

string

Identifier of placement group

NetworkSettings

Field

Description

type

enum (Type)

Required field. Network type that specifies the network configuration for the node group instances.

STANDARD: Standard network.
SOFTWARE_ACCELERATED: Software accelerated network.

ContainerRuntimeSettings

Field

Description

type

enum (Type)

Required field. Type of container runtime.

DOCKER: Docker container runtime.
CONTAINERD: Containerd container runtime.

ContainerNetworkSettings

Field

Description

podMtu

string (int64)

MTU (Maximum Transmission Unit) size for pod network interfaces.

GpuSettings

Field

Description

gpuClusterId

string

GPU cluster id, that mk8s node will join.

gpuEnvironment

enum (GpuEnvironment)

GPU environment configured on node.

RUNC_DRIVERS_CUDA: Use a node image with the pre-installed GPU toolkit, drivers and CUDA.
RUNC: Use a node image with the pre-installed GPU toolkit but without drivers.
You should install drivers on a node yourself in that case.
There are tools to help you to do that, for example gpu-operator.

ScalePolicy

Field

Description

fixedScale

FixedScale

Fixed scale policy of the node group.

Includes only one of the fields fixedScale, autoScale.

autoScale

AutoScale

Auto scale policy of the node group.

Includes only one of the fields fixedScale, autoScale.

FixedScale

Field

Description

size

string (int64)

Number of nodes in the node group.

Acceptable values are 0 to 100, inclusive.

AutoScale

Field	Description
minSize	string (int64) Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
maxSize	string (int64) Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
initialSize	string (int64) Initial number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

NodeGroupAllocationPolicy

Field

Description

locations[]

NodeGroupLocation

List of locations where resources for the node group will be allocated.

NodeGroupLocation

Field

Description

zoneId

string

Required field. ID of the availability zone where the nodes may reside.

subnetId

string

ID of the subnet. If a network chosen for the Kubernetes cluster has only one subnet in the specified zone, subnet ID may be omitted.

DeployPolicy

Field

Description

maxUnavailable

string (int64)

Acceptable values are 0 to 100, inclusive.

maxExpansion

string (int64)

Acceptable values are 0 to 100, inclusive.

VersionInfo

Field	Description
currentVersion	string Current Kubernetes version, format: major.minor (e.g. 1.15).
newRevisionAvailable	boolean Newer revisions may include Kubernetes patches (e.g 1.15.1 -> 1.15.2) as well as some internal component updates - new features or bug fixes in platform specific components either on the master or nodes.
newRevisionSummary	string Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
versionDeprecated	boolean The current version is on the deprecation schedule, component (master or node group) should be upgraded.

NodeGroupMaintenancePolicy

Field	Description
autoUpgrade	boolean If set to true, automatic updates are installed in the specified period of time with no interaction from the user. If set to false, automatic upgrades are disabled.
autoRepair	boolean If set to true, automatic repairs are enabled. Default value is false.
maintenanceWindow	MaintenanceWindow Maintenance window settings. Update will start at the specified time and last no more than the specified duration. The time is set in UTC.

MaintenanceWindow

Field	Description
anytime	object Updating the master at any time. Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`. Maintenance policy.
dailyMaintenanceWindow	DailyMaintenanceWindow Updating the master on any day during the specified time window. Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`. Maintenance policy.
weeklyMaintenanceWindow	WeeklyMaintenanceWindow Updating the master on selected days during the specified time window. Includes only one of the fields `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`. Maintenance policy.

DailyMaintenanceWindow

Field

Description

startTime

TimeOfDay

Required field. Window start time, in the UTC timezone.

duration

string (duration)

Window duration.

TimeOfDay

Field	Description
hours	integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
seconds	integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

WeeklyMaintenanceWindow

Field

Description

daysOfWeek[]

DaysOfWeekMaintenanceWindow

Days of the week and the maintenance window for these days when automatic updates are allowed.

The number of elements must be in the range 1-7.

DaysOfWeekMaintenanceWindow

Field	Description
days[]	enum (DayOfWeek) Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7. `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.
startTime	TimeOfDay Required field. Window start time, in the UTC timezone.
duration	string (duration) Window duration.

Taint

Field	Description
key	string The taint key to be applied to a node.
value	string The taint value corresponding to the taint key.
effect	enum (Effect) The effect of the taint on pods that do not tolerate the taint. `NO_SCHEDULE`: Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. `PREFER_NO_SCHEDULE`: Like NO_SCHEDULE, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler. `NO_EXECUTE`: Evict any already-running pods that do not tolerate the taint.

Variable

Variable is a user-defined key-value pair used for templating.

Field

Description

key

string

Variable name.
Must be unique within the node group.

The string length in characters must be 1-128. Value must match the regular expression [a-zA-Z0-9._-]*.

value

string

Variable value.

The maximum string length in characters is 262144.

NodeGroupWorkloadIdentityFederation

NodeGroupWorkloadIdentityFederation contains configuration for Workload Identity Federation.

Field

Description

enabled

boolean

Identifies whether Workload Identity Federation is enabled.

Managed Services for Kubernetes API, REST: NodeGroup.Update

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

NodeTemplateNodeTemplate

ResourcesSpecResourcesSpec

DiskSpecDiskSpec

NodeAddressSpecNodeAddressSpec

OneToOneNatSpecOneToOneNatSpec

DnsRecordSpecDnsRecordSpec

SchedulingPolicySchedulingPolicy

NetworkInterfaceSpecNetworkInterfaceSpec

PlacementPolicyPlacementPolicy

NetworkSettingsNetworkSettings

ContainerRuntimeSettingsContainerRuntimeSettings

ContainerNetworkSettingsContainerNetworkSettings

GpuSettingsGpuSettings

ScalePolicyScalePolicy

FixedScaleFixedScale

AutoScaleAutoScale

NodeGroupAllocationPolicyNodeGroupAllocationPolicy

NodeGroupLocationNodeGroupLocation

DeployPolicyDeployPolicy

UpdateVersionSpecUpdateVersionSpec

NodeGroupMaintenancePolicyNodeGroupMaintenancePolicy

MaintenanceWindowMaintenanceWindow

DailyMaintenanceWindowDailyMaintenanceWindow

TimeOfDayTimeOfDay

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

DaysOfWeekMaintenanceWindowDaysOfWeekMaintenanceWindow

TaintTaint

VariableVariable

NodeGroupWorkloadIdentityFederationNodeGroupWorkloadIdentityFederation

ResponseResponse

UpdateNodeGroupMetadataUpdateNodeGroupMetadata

StatusStatus

NodeGroupNodeGroup

NodeTemplateNodeTemplate

ResourcesSpecResourcesSpec

DiskSpecDiskSpec

NodeAddressSpecNodeAddressSpec

OneToOneNatSpecOneToOneNatSpec

DnsRecordSpecDnsRecordSpec

SchedulingPolicySchedulingPolicy

NetworkInterfaceSpecNetworkInterfaceSpec

PlacementPolicyPlacementPolicy

NetworkSettingsNetworkSettings

ContainerRuntimeSettingsContainerRuntimeSettings

ContainerNetworkSettingsContainerNetworkSettings

GpuSettingsGpuSettings

ScalePolicyScalePolicy

FixedScaleFixedScale

AutoScaleAutoScale

NodeGroupAllocationPolicyNodeGroupAllocationPolicy

NodeGroupLocationNodeGroupLocation

DeployPolicyDeployPolicy

VersionInfoVersionInfo

NodeGroupMaintenancePolicyNodeGroupMaintenancePolicy

MaintenanceWindowMaintenanceWindow

DailyMaintenanceWindowDailyMaintenanceWindow

TimeOfDayTimeOfDay

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

DaysOfWeekMaintenanceWindowDaysOfWeekMaintenanceWindow

TaintTaint

VariableVariable

NodeGroupWorkloadIdentityFederationNodeGroupWorkloadIdentityFederation

Was the article helpful?

HTTP request

Path parameters

Body parameters

NodeTemplate

ResourcesSpec

DiskSpec

NodeAddressSpec

OneToOneNatSpec

DnsRecordSpec

SchedulingPolicy

NetworkInterfaceSpec

PlacementPolicy

NetworkSettings

ContainerRuntimeSettings

ContainerNetworkSettings

GpuSettings

ScalePolicy

FixedScale

AutoScale

NodeGroupAllocationPolicy

NodeGroupLocation

DeployPolicy

UpdateVersionSpec

NodeGroupMaintenancePolicy

MaintenanceWindow

DailyMaintenanceWindow

TimeOfDay

WeeklyMaintenanceWindow

DaysOfWeekMaintenanceWindow

Taint

Variable

NodeGroupWorkloadIdentityFederation

Response

UpdateNodeGroupMetadata

Status

NodeGroup

NodeTemplate

ResourcesSpec

DiskSpec

NodeAddressSpec

OneToOneNatSpec

DnsRecordSpec

SchedulingPolicy

NetworkInterfaceSpec

PlacementPolicy

NetworkSettings

ContainerRuntimeSettings

ContainerNetworkSettings

GpuSettings

ScalePolicy

FixedScale

AutoScale

NodeGroupAllocationPolicy

NodeGroupLocation

DeployPolicy

VersionInfo

NodeGroupMaintenancePolicy

MaintenanceWindow

DailyMaintenanceWindow

TimeOfDay

WeeklyMaintenanceWindow

DaysOfWeekMaintenanceWindow

Taint

Variable

NodeGroupWorkloadIdentityFederation