Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Managed Service for Kubernetes
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Connecting to a node over SSH
    • Creating a configuration file
    • Configuring a Kubernetes cluster network
      • Granting access to an app running in a Kubernetes cluster
      • Using Kubernetes cluster network policies
    • Encrypting secrets
    • Using persistent volumes
      • Dynamically preparing volumes
      • Statically preparing volumes
      • Managing storage classes
      • Expanding a volume
      • Mounting a volume in Block mode
    • Managing a Kubernetes cluster
      • Adding Kubernetes cluster credentials to the kubectl configuration file
      • Getting information about a Kubernetes cluster
      • Creating a Kubernetes cluster
      • Editing a Kubernetes cluster
      • Deleting a Kubernetes cluster
    • Managing a node group
      • Getting information about a node group
      • Creating a node group
      • Editing a node group
      • Deleting a node group
  • Solutions
    • Integration with Container Registry
    • Running workloads with GPUs
    • Making backups to Object Storage
  • Concepts
    • Relationship between service resources
    • Release channels and updates
    • Using Kubernetes API objects
      • Volume
      • Service
    • Node group
      • Autoscaling node groups
      • Evicting pods from a node
      • Dynamic resource allocation for a node
      • Node groups with GPUs
    • Kubernetes cluster network policies
    • Quotas and limits
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • ClusterService
      • NodeGroupService
      • VersionService
      • OperationService
    • REST
      • Overview
      • Cluster
        • Overview
        • create
        • delete
        • get
        • list
        • listNodeGroups
        • listNodes
        • listOperations
        • start
        • stop
        • update
      • NodeGroup
        • Overview
        • create
        • delete
        • get
        • list
        • listNodes
        • listOperations
        • update
      • Version
        • Overview
        • list
  • Questions and answers
  1. API reference
  2. gRPC
  3. NodeGroupService

NodeGroupService

  • Calls NodeGroupService
  • Get
    • GetNodeGroupRequest
    • NodeGroup
    • NodeTemplate
    • ResourcesSpec
    • DiskSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • SchedulingPolicy
    • NetworkInterfaceSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • ScalePolicy
    • FixedScale
    • AutoScale
    • NodeGroupAllocationPolicy
    • NodeGroupLocation
    • DeployPolicy
    • VersionInfo
    • NodeGroupMaintenancePolicy
    • MaintenanceWindow
    • AnytimeMaintenanceWindow
    • DailyMaintenanceWindow
    • WeeklyMaintenanceWindow
    • DaysOfWeekMaintenanceWindow
    • Taint
  • List
    • ListNodeGroupsRequest
    • ListNodeGroupsResponse
    • NodeGroup
    • NodeTemplate
    • ResourcesSpec
    • DiskSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • SchedulingPolicy
    • NetworkInterfaceSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • ScalePolicy
    • FixedScale
    • AutoScale
    • NodeGroupAllocationPolicy
    • NodeGroupLocation
    • DeployPolicy
    • VersionInfo
    • NodeGroupMaintenancePolicy
    • MaintenanceWindow
    • AnytimeMaintenanceWindow
    • DailyMaintenanceWindow
    • WeeklyMaintenanceWindow
    • DaysOfWeekMaintenanceWindow
    • Taint
  • Create
    • CreateNodeGroupRequest
    • NodeTemplate
    • ResourcesSpec
    • DiskSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • SchedulingPolicy
    • NetworkInterfaceSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • ScalePolicy
    • FixedScale
    • AutoScale
    • NodeGroupAllocationPolicy
    • NodeGroupLocation
    • DeployPolicy
    • NodeGroupMaintenancePolicy
    • MaintenanceWindow
    • AnytimeMaintenanceWindow
    • DailyMaintenanceWindow
    • WeeklyMaintenanceWindow
    • DaysOfWeekMaintenanceWindow
    • Taint
    • Operation
    • CreateNodeGroupMetadata
    • NodeGroup
    • NodeTemplate
    • ResourcesSpec
    • DiskSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • SchedulingPolicy
    • NetworkInterfaceSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • ScalePolicy
    • FixedScale
    • AutoScale
    • NodeGroupAllocationPolicy
    • NodeGroupLocation
    • DeployPolicy
    • VersionInfo
    • NodeGroupMaintenancePolicy
    • MaintenanceWindow
    • AnytimeMaintenanceWindow
    • DailyMaintenanceWindow
    • WeeklyMaintenanceWindow
    • DaysOfWeekMaintenanceWindow
    • Taint
  • Update
    • UpdateNodeGroupRequest
    • NodeTemplate
    • ResourcesSpec
    • DiskSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • SchedulingPolicy
    • NetworkInterfaceSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • ScalePolicy
    • FixedScale
    • AutoScale
    • NodeGroupAllocationPolicy
    • NodeGroupLocation
    • DeployPolicy
    • UpdateVersionSpec
    • NodeGroupMaintenancePolicy
    • MaintenanceWindow
    • AnytimeMaintenanceWindow
    • DailyMaintenanceWindow
    • WeeklyMaintenanceWindow
    • DaysOfWeekMaintenanceWindow
    • Taint
    • Operation
    • UpdateNodeGroupMetadata
    • NodeGroup
    • NodeTemplate
    • ResourcesSpec
    • DiskSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • SchedulingPolicy
    • NetworkInterfaceSpec
    • NodeAddressSpec
    • OneToOneNatSpec
    • ScalePolicy
    • FixedScale
    • AutoScale
    • NodeGroupAllocationPolicy
    • NodeGroupLocation
    • DeployPolicy
    • VersionInfo
    • NodeGroupMaintenancePolicy
    • MaintenanceWindow
    • AnytimeMaintenanceWindow
    • DailyMaintenanceWindow
    • WeeklyMaintenanceWindow
    • DaysOfWeekMaintenanceWindow
    • Taint
  • Delete
    • DeleteNodeGroupRequest
    • Operation
    • DeleteNodeGroupMetadata
  • ListOperations
    • ListNodeGroupOperationsRequest
    • ListNodeGroupOperationsResponse
    • Operation
  • ListNodes
    • ListNodeGroupNodesRequest
    • ListNodeGroupNodesResponse
    • Node
    • KubernetesStatus
    • CloudStatus
    • Spec

A set of methods for managing node groups.

Call Description
Get Returns the specified node group.
List Retrieves the list of node group in the specified Kubernetes cluster.
Create Creates a node group in the specified Kubernetes cluster.
Update Updates the specified node group.
Delete Deletes the specified node group.
ListOperations Lists operations for the specified node group.
ListNodes Retrieves the list of nodes in the specified Kubernetes cluster.

Calls NodeGroupService

Get

Returns the specified node group.
To get the list of available node group, make a List request.

rpc Get (GetNodeGroupRequest) returns (NodeGroup)

GetNodeGroupRequest

Field Description
node_group_id string
Required. ID of the node group to return. To get the node group ID use a NodeGroupService.List request.

NodeGroup

Field Description
id string
ID of the node group.
cluster_id string
ID of the cluster that the node group belongs to.
created_at google.protobuf.Timestamp
Creation timestamp.
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 map<string,string>
Resource labels as key:value pairs. Мaximum 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.
    node_template NodeTemplate
    Node template that specifies parameters of the compute instances for the node group.
    scale_policy ScalePolicy
    Scale policy of the node group. For more information, see Scaling policy.
    allocation_policy NodeGroupAllocationPolicy
    Allocation policy by which resources for node group are allocated to zones and regions.
    deploy_policy DeployPolicy
    Deploy policy according to which the updates are rolled out.
    instance_group_id string
    ID of the managed instance group associated with this node group.
    node_version string
    Version of Kubernetes components that runs on the nodes. Deprecated. Use version_info.current_version.
    version_info VersionInfo
    Detailed information about the Kubernetes version that is running on the node.
    maintenance_policy NodeGroupMaintenancePolicy
    Maintenance policy of the node group.
    allowed_unsafe_sysctls[] string
    Support for unsafe sysctl parameters. For more details see documentation.
    node_taints[] Taint
    Taints that are applied to the nodes of the node group at creation time.
    node_labels map<string,string>
    Labels that are assigned to the nodes of the node group at creation time.

    NodeTemplate

    Field Description
    platform_id string
    ID of the hardware platform configuration for the node.
    resources_spec ResourcesSpec
    Computing resources of the node such as the amount of memory and number of cores.
    boot_disk_spec DiskSpec
    Specification for the boot disk that will be attached to the node.
    metadata map<string,string>
    The metadata as key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.
    For example, you may use the metadata in order to provide your public SSH key to the node. For more information, see Metadata. 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]*.
    v4_address_spec NodeAddressSpec
    Specification for the create network interfaces for the node group compute instances. Deprecated, please use network_interface_specs.
    scheduling_policy SchedulingPolicy
    Scheduling policy configuration.
    network_interface_specs[] NetworkInterfaceSpec
    New api, to specify network interfaces for the node group compute instances. Can not be used together with 'v4_address_spec'

    ResourcesSpec

    Field Description
    memory int64
    Amount of memory available to the node, specified in bytes. The minimum value is 0.
    cores int64
    Number of cores available to the node. The minimum value is 0.
    core_fraction 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 int64
    Number of GPUs available to the node. The minimum value is 0.

    DiskSpec

    Field Description
    disk_type_id string
    ID of the disk type. Value must match the regular expression |network-ssd|network-hdd.
    disk_size int64
    Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive.

    NodeAddressSpec

    Field Description
    one_to_one_nat_spec 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.

    OneToOneNatSpec

    Field Description
    ip_version enum IpVersion
    IP version for the public IP address.
    • IPV4: IPv4 address, for example 192.168.0.0.
    • IPV6: IPv6 address, not available yet.

      SchedulingPolicy

      Field Description
      preemptible bool
      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
      subnet_ids[] string
      IDs of the subnets.
      primary_v4_address_spec NodeAddressSpec
      Primary IPv4 address that is assigned to the instance for this network interface.
      primary_v6_address_spec NodeAddressSpec
      Primary IPv6 address that is assigned to the instance for this network interface.
      security_group_ids[] string
      IDs of security groups.

      NodeAddressSpec

      Field Description
      one_to_one_nat_spec 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.

      OneToOneNatSpec

      Field Description
      ip_version enum IpVersion
      IP version for the public IP address.
      • IPV4: IPv4 address, for example 192.168.0.0.
      • IPV6: IPv6 address, not available yet.

        ScalePolicy

        Field Description
        scale_type oneof: fixed_scale or auto_scale
          fixed_scale FixedScale
        Fixed scale policy of the node group.
          auto_scale AutoScale
        Auto scale policy of the node group.

        FixedScale

        Field Description
        size int64
        Number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

        AutoScale

        Field Description
        min_size int64
        Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
        max_size int64
        Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
        initial_size 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
        zone_id string
        Required. ID of the availability zone where the nodes may reside.
        subnet_id 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
        max_unavailable 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 max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.
        max_expansion int64
        The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.

        VersionInfo

        Field Description
        current_version string
        Current Kubernetes version, format: major.minor (e.g. 1.15).
        new_revision_available bool
        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 Yandex specific components either on the master or nodes.
        new_revision_summary string
        Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
        version_deprecated bool
        The current version is on the deprecation schedule, component (master or node group) should be upgraded.

        NodeGroupMaintenancePolicy

        Field Description
        auto_upgrade bool
        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.
        auto_repair bool
        If set to true, automatic repairs are enabled. Default value is false.
        maintenance_window 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
        policy oneof: anytime, daily_maintenance_window or weekly_maintenance_window
        Maintenance policy.
          anytime AnytimeMaintenanceWindow
        Updating the master at any time.
          daily_maintenance_window DailyMaintenanceWindow
        Updating the master on any day during the specified time window.
          weekly_maintenance_window WeeklyMaintenanceWindow
        Updating the master on selected days during the specified time window.

        AnytimeMaintenanceWindow

        DailyMaintenanceWindow

        Field Description
        start_time google.type.TimeOfDay
        Required. Window start time, in the UTC timezone.
        duration google.protobuf.Duration
        Window duration. Acceptable values are 1h to 24h, inclusive.

        WeeklyMaintenanceWindow

        Field Description
        days_of_week[] 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[] google.type.DayOfWeek
        Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7.
        start_time google.type.TimeOfDay
        Required. Window start time, in the UTC timezone.
        duration google.protobuf.Duration
        Window duration. Acceptable values are 1h to 24h, inclusive.

        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.

          List

          Retrieves the list of node group in the specified Kubernetes cluster.

          rpc List (ListNodeGroupsRequest) returns (ListNodeGroupsResponse)

          ListNodeGroupsRequest

          Field Description
          folder_id string
          Required. ID of the folder to list node groups in. To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.List request.
          page_size int64
          The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListNodeGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
          page_token string
          Page token. To get the next page of results, set page_token to the ListNodeGroupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
          filter string
          1. The field name. Currently you can use filtering only on NodeGroup.name field.
          2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values.
          3. The value. Must be 1-61 characters long and match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
          The maximum string length in characters is 1000.

          ListNodeGroupsResponse

          Field Description
          node_groups[] NodeGroup
          List of node groups.
          next_page_token string
          This token allows you to get the next page of results for list requests. If the number of results is larger than ListNodeGroupsRequest.page_size, use the next_page_token as the value for the ListNodeGroupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

          NodeGroup

          Field Description
          id string
          ID of the node group.
          cluster_id string
          ID of the cluster that the node group belongs to.
          created_at google.protobuf.Timestamp
          Creation timestamp.
          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 map<string,string>
          Resource labels as key:value pairs. Мaximum 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.
            node_template NodeTemplate
            Node template that specifies parameters of the compute instances for the node group.
            scale_policy ScalePolicy
            Scale policy of the node group. For more information, see Scaling policy.
            allocation_policy NodeGroupAllocationPolicy
            Allocation policy by which resources for node group are allocated to zones and regions.
            deploy_policy DeployPolicy
            Deploy policy according to which the updates are rolled out.
            instance_group_id string
            ID of the managed instance group associated with this node group.
            node_version string
            Version of Kubernetes components that runs on the nodes. Deprecated. Use version_info.current_version.
            version_info VersionInfo
            Detailed information about the Kubernetes version that is running on the node.
            maintenance_policy NodeGroupMaintenancePolicy
            Maintenance policy of the node group.
            allowed_unsafe_sysctls[] string
            Support for unsafe sysctl parameters. For more details see documentation.
            node_taints[] Taint
            Taints that are applied to the nodes of the node group at creation time.
            node_labels map<string,string>
            Labels that are assigned to the nodes of the node group at creation time.

            NodeTemplate

            Field Description
            platform_id string
            ID of the hardware platform configuration for the node.
            resources_spec ResourcesSpec
            Computing resources of the node such as the amount of memory and number of cores.
            boot_disk_spec DiskSpec
            Specification for the boot disk that will be attached to the node.
            metadata map<string,string>
            The metadata as key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.
            For example, you may use the metadata in order to provide your public SSH key to the node. For more information, see Metadata. 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]*.
            v4_address_spec NodeAddressSpec
            Specification for the create network interfaces for the node group compute instances. Deprecated, please use network_interface_specs.
            scheduling_policy SchedulingPolicy
            Scheduling policy configuration.
            network_interface_specs[] NetworkInterfaceSpec
            New api, to specify network interfaces for the node group compute instances. Can not be used together with 'v4_address_spec'

            ResourcesSpec

            Field Description
            memory int64
            Amount of memory available to the node, specified in bytes. The minimum value is 0.
            cores int64
            Number of cores available to the node. The minimum value is 0.
            core_fraction 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 int64
            Number of GPUs available to the node. The minimum value is 0.

            DiskSpec

            Field Description
            disk_type_id string
            ID of the disk type. Value must match the regular expression |network-ssd|network-hdd.
            disk_size int64
            Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive.

            NodeAddressSpec

            Field Description
            one_to_one_nat_spec 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.

            OneToOneNatSpec

            Field Description
            ip_version enum IpVersion
            IP version for the public IP address.
            • IPV4: IPv4 address, for example 192.168.0.0.
            • IPV6: IPv6 address, not available yet.

              SchedulingPolicy

              Field Description
              preemptible bool
              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
              subnet_ids[] string
              IDs of the subnets.
              primary_v4_address_spec NodeAddressSpec
              Primary IPv4 address that is assigned to the instance for this network interface.
              primary_v6_address_spec NodeAddressSpec
              Primary IPv6 address that is assigned to the instance for this network interface.
              security_group_ids[] string
              IDs of security groups.

              NodeAddressSpec

              Field Description
              one_to_one_nat_spec 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.

              OneToOneNatSpec

              Field Description
              ip_version enum IpVersion
              IP version for the public IP address.
              • IPV4: IPv4 address, for example 192.168.0.0.
              • IPV6: IPv6 address, not available yet.

                ScalePolicy

                Field Description
                scale_type oneof: fixed_scale or auto_scale
                  fixed_scale FixedScale
                Fixed scale policy of the node group.
                  auto_scale AutoScale
                Auto scale policy of the node group.

                FixedScale

                Field Description
                size int64
                Number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

                AutoScale

                Field Description
                min_size int64
                Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                max_size int64
                Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                initial_size 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
                zone_id string
                Required. ID of the availability zone where the nodes may reside.
                subnet_id 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
                max_unavailable 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 max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.
                max_expansion int64
                The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.

                VersionInfo

                Field Description
                current_version string
                Current Kubernetes version, format: major.minor (e.g. 1.15).
                new_revision_available bool
                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 Yandex specific components either on the master or nodes.
                new_revision_summary string
                Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
                version_deprecated bool
                The current version is on the deprecation schedule, component (master or node group) should be upgraded.

                NodeGroupMaintenancePolicy

                Field Description
                auto_upgrade bool
                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.
                auto_repair bool
                If set to true, automatic repairs are enabled. Default value is false.
                maintenance_window 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
                policy oneof: anytime, daily_maintenance_window or weekly_maintenance_window
                Maintenance policy.
                  anytime AnytimeMaintenanceWindow
                Updating the master at any time.
                  daily_maintenance_window DailyMaintenanceWindow
                Updating the master on any day during the specified time window.
                  weekly_maintenance_window WeeklyMaintenanceWindow
                Updating the master on selected days during the specified time window.

                AnytimeMaintenanceWindow

                DailyMaintenanceWindow

                Field Description
                start_time google.type.TimeOfDay
                Required. Window start time, in the UTC timezone.
                duration google.protobuf.Duration
                Window duration. Acceptable values are 1h to 24h, inclusive.

                WeeklyMaintenanceWindow

                Field Description
                days_of_week[] 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[] google.type.DayOfWeek
                Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7.
                start_time google.type.TimeOfDay
                Required. Window start time, in the UTC timezone.
                duration google.protobuf.Duration
                Window duration. Acceptable values are 1h to 24h, inclusive.

                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.

                  Create

                  Creates a node group in the specified Kubernetes cluster.

                  rpc Create (CreateNodeGroupRequest) returns (operation.Operation)

                  Metadata and response of Operation:

                      Operation.metadata:CreateNodeGroupMetadata

                      Operation.response:NodeGroup

                  CreateNodeGroupRequest

                  Field Description
                  cluster_id string
                  Required. ID of the Kubernetes cluster to create a node group in. To get the Kubernetes cluster ID, use a ClusterService.List request.
                  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 map<string,string>
                  Resource labels as key:value pairs. 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]*.
                  node_template NodeTemplate
                  Required. Node template for creating the node group.
                  scale_policy ScalePolicy
                  Required. Scale policy of the node group.
                  allocation_policy NodeGroupAllocationPolicy
                  Allocation policy of the node group by the zones and regions.
                  deploy_policy DeployPolicy
                  Deploy policy according to which the updates are rolled out. If not specified, the default is used.
                  version string
                  Version of Kubernetes components that runs on the nodes.
                  maintenance_policy NodeGroupMaintenancePolicy
                  Maintenance policy of the node group.
                  allowed_unsafe_sysctls[] 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*].
                  node_taints[] Taint
                  Taints that are applied to the nodes of the node group at creation time.
                  node_labels map<string,string>
                  Labels that are assigned to the nodes of the node group at creation time.

                  NodeTemplate

                  Field Description
                  platform_id string
                  ID of the hardware platform configuration for the node.
                  resources_spec ResourcesSpec
                  Computing resources of the node such as the amount of memory and number of cores.
                  boot_disk_spec DiskSpec
                  Specification for the boot disk that will be attached to the node.
                  metadata map<string,string>
                  The metadata as key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.
                  For example, you may use the metadata in order to provide your public SSH key to the node. For more information, see Metadata. 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]*.
                  v4_address_spec NodeAddressSpec
                  Specification for the create network interfaces for the node group compute instances. Deprecated, please use network_interface_specs.
                  scheduling_policy SchedulingPolicy
                  Scheduling policy configuration.
                  network_interface_specs[] NetworkInterfaceSpec
                  New api, to specify network interfaces for the node group compute instances. Can not be used together with 'v4_address_spec'

                  ResourcesSpec

                  Field Description
                  memory int64
                  Amount of memory available to the node, specified in bytes. The minimum value is 0.
                  cores int64
                  Number of cores available to the node. The minimum value is 0.
                  core_fraction 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 int64
                  Number of GPUs available to the node. The minimum value is 0.

                  DiskSpec

                  Field Description
                  disk_type_id string
                  ID of the disk type. Value must match the regular expression |network-ssd|network-hdd.
                  disk_size int64
                  Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive.

                  NodeAddressSpec

                  Field Description
                  one_to_one_nat_spec 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.

                  OneToOneNatSpec

                  Field Description
                  ip_version enum IpVersion
                  IP version for the public IP address.
                  • IPV4: IPv4 address, for example 192.168.0.0.
                  • IPV6: IPv6 address, not available yet.

                    SchedulingPolicy

                    Field Description
                    preemptible bool
                    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
                    subnet_ids[] string
                    IDs of the subnets.
                    primary_v4_address_spec NodeAddressSpec
                    Primary IPv4 address that is assigned to the instance for this network interface.
                    primary_v6_address_spec NodeAddressSpec
                    Primary IPv6 address that is assigned to the instance for this network interface.
                    security_group_ids[] string
                    IDs of security groups.

                    NodeAddressSpec

                    Field Description
                    one_to_one_nat_spec 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.

                    OneToOneNatSpec

                    Field Description
                    ip_version enum IpVersion
                    IP version for the public IP address.
                    • IPV4: IPv4 address, for example 192.168.0.0.
                    • IPV6: IPv6 address, not available yet.

                      ScalePolicy

                      Field Description
                      scale_type oneof: fixed_scale or auto_scale
                        fixed_scale FixedScale
                      Fixed scale policy of the node group.
                        auto_scale AutoScale
                      Auto scale policy of the node group.

                      FixedScale

                      Field Description
                      size int64
                      Number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

                      AutoScale

                      Field Description
                      min_size int64
                      Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                      max_size int64
                      Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                      initial_size 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
                      zone_id string
                      Required. ID of the availability zone where the nodes may reside.
                      subnet_id 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
                      max_unavailable 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 max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.
                      max_expansion int64
                      The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.

                      NodeGroupMaintenancePolicy

                      Field Description
                      auto_upgrade bool
                      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.
                      auto_repair bool
                      If set to true, automatic repairs are enabled. Default value is false.
                      maintenance_window 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
                      policy oneof: anytime, daily_maintenance_window or weekly_maintenance_window
                      Maintenance policy.
                        anytime AnytimeMaintenanceWindow
                      Updating the master at any time.
                        daily_maintenance_window DailyMaintenanceWindow
                      Updating the master on any day during the specified time window.
                        weekly_maintenance_window WeeklyMaintenanceWindow
                      Updating the master on selected days during the specified time window.

                      AnytimeMaintenanceWindow

                      DailyMaintenanceWindow

                      Field Description
                      start_time google.type.TimeOfDay
                      Required. Window start time, in the UTC timezone.
                      duration google.protobuf.Duration
                      Window duration. Acceptable values are 1h to 24h, inclusive.

                      WeeklyMaintenanceWindow

                      Field Description
                      days_of_week[] 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[] google.type.DayOfWeek
                      Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7.
                      start_time google.type.TimeOfDay
                      Required. Window start time, in the UTC timezone.
                      duration google.protobuf.Duration
                      Window duration. Acceptable values are 1h to 24h, inclusive.

                      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.

                        Operation

                        Field Description
                        id string
                        ID of the operation.
                        description string
                        Description of the operation. 0-256 characters long.
                        created_at google.protobuf.Timestamp
                        Creation timestamp.
                        created_by string
                        ID of the user or service account who initiated the operation.
                        modified_at google.protobuf.Timestamp
                        The time when the Operation resource was last modified.
                        done bool
                        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 google.protobuf.Any<CreateNodeGroupMetadata>
                        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.
                        result oneof: error or 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.
                          error google.rpc.Status
                        The error result of the operation in case of failure or cancellation.
                          response google.protobuf.Any<NodeGroup>
                        if operation finished successfully.

                        CreateNodeGroupMetadata

                        Field Description
                        node_group_id string
                        ID of the node group that is being created.

                        NodeGroup

                        Field Description
                        id string
                        ID of the node group.
                        cluster_id string
                        ID of the cluster that the node group belongs to.
                        created_at google.protobuf.Timestamp
                        Creation timestamp.
                        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 map<string,string>
                        Resource labels as key:value pairs. Мaximum 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.
                          node_template NodeTemplate
                          Node template that specifies parameters of the compute instances for the node group.
                          scale_policy ScalePolicy
                          Scale policy of the node group. For more information, see Scaling policy.
                          allocation_policy NodeGroupAllocationPolicy
                          Allocation policy by which resources for node group are allocated to zones and regions.
                          deploy_policy DeployPolicy
                          Deploy policy according to which the updates are rolled out.
                          instance_group_id string
                          ID of the managed instance group associated with this node group.
                          node_version string
                          Version of Kubernetes components that runs on the nodes. Deprecated. Use version_info.current_version.
                          version_info VersionInfo
                          Detailed information about the Kubernetes version that is running on the node.
                          maintenance_policy NodeGroupMaintenancePolicy
                          Maintenance policy of the node group.
                          allowed_unsafe_sysctls[] string
                          Support for unsafe sysctl parameters. For more details see documentation.
                          node_taints[] Taint
                          Taints that are applied to the nodes of the node group at creation time.
                          node_labels map<string,string>
                          Labels that are assigned to the nodes of the node group at creation time.

                          NodeTemplate

                          Field Description
                          platform_id string
                          ID of the hardware platform configuration for the node.
                          resources_spec ResourcesSpec
                          Computing resources of the node such as the amount of memory and number of cores.
                          boot_disk_spec DiskSpec
                          Specification for the boot disk that will be attached to the node.
                          metadata map<string,string>
                          The metadata as key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.
                          For example, you may use the metadata in order to provide your public SSH key to the node. For more information, see Metadata. 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]*.
                          v4_address_spec NodeAddressSpec
                          Specification for the create network interfaces for the node group compute instances. Deprecated, please use network_interface_specs.
                          scheduling_policy SchedulingPolicy
                          Scheduling policy configuration.
                          network_interface_specs[] NetworkInterfaceSpec
                          New api, to specify network interfaces for the node group compute instances. Can not be used together with 'v4_address_spec'

                          ResourcesSpec

                          Field Description
                          memory int64
                          Amount of memory available to the node, specified in bytes. The minimum value is 0.
                          cores int64
                          Number of cores available to the node. The minimum value is 0.
                          core_fraction 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 int64
                          Number of GPUs available to the node. The minimum value is 0.

                          DiskSpec

                          Field Description
                          disk_type_id string
                          ID of the disk type. Value must match the regular expression |network-ssd|network-hdd.
                          disk_size int64
                          Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive.

                          NodeAddressSpec

                          Field Description
                          one_to_one_nat_spec 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.

                          OneToOneNatSpec

                          Field Description
                          ip_version enum IpVersion
                          IP version for the public IP address.
                          • IPV4: IPv4 address, for example 192.168.0.0.
                          • IPV6: IPv6 address, not available yet.

                            SchedulingPolicy

                            Field Description
                            preemptible bool
                            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
                            subnet_ids[] string
                            IDs of the subnets.
                            primary_v4_address_spec NodeAddressSpec
                            Primary IPv4 address that is assigned to the instance for this network interface.
                            primary_v6_address_spec NodeAddressSpec
                            Primary IPv6 address that is assigned to the instance for this network interface.
                            security_group_ids[] string
                            IDs of security groups.

                            NodeAddressSpec

                            Field Description
                            one_to_one_nat_spec 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.

                            OneToOneNatSpec

                            Field Description
                            ip_version enum IpVersion
                            IP version for the public IP address.
                            • IPV4: IPv4 address, for example 192.168.0.0.
                            • IPV6: IPv6 address, not available yet.

                              ScalePolicy

                              Field Description
                              scale_type oneof: fixed_scale or auto_scale
                                fixed_scale FixedScale
                              Fixed scale policy of the node group.
                                auto_scale AutoScale
                              Auto scale policy of the node group.

                              FixedScale

                              Field Description
                              size int64
                              Number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

                              AutoScale

                              Field Description
                              min_size int64
                              Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                              max_size int64
                              Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                              initial_size 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
                              zone_id string
                              Required. ID of the availability zone where the nodes may reside.
                              subnet_id 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
                              max_unavailable 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 max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.
                              max_expansion int64
                              The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.

                              VersionInfo

                              Field Description
                              current_version string
                              Current Kubernetes version, format: major.minor (e.g. 1.15).
                              new_revision_available bool
                              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 Yandex specific components either on the master or nodes.
                              new_revision_summary string
                              Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
                              version_deprecated bool
                              The current version is on the deprecation schedule, component (master or node group) should be upgraded.

                              NodeGroupMaintenancePolicy

                              Field Description
                              auto_upgrade bool
                              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.
                              auto_repair bool
                              If set to true, automatic repairs are enabled. Default value is false.
                              maintenance_window 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
                              policy oneof: anytime, daily_maintenance_window or weekly_maintenance_window
                              Maintenance policy.
                                anytime AnytimeMaintenanceWindow
                              Updating the master at any time.
                                daily_maintenance_window DailyMaintenanceWindow
                              Updating the master on any day during the specified time window.
                                weekly_maintenance_window WeeklyMaintenanceWindow
                              Updating the master on selected days during the specified time window.

                              AnytimeMaintenanceWindow

                              DailyMaintenanceWindow

                              Field Description
                              start_time google.type.TimeOfDay
                              Required. Window start time, in the UTC timezone.
                              duration google.protobuf.Duration
                              Window duration. Acceptable values are 1h to 24h, inclusive.

                              WeeklyMaintenanceWindow

                              Field Description
                              days_of_week[] 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[] google.type.DayOfWeek
                              Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7.
                              start_time google.type.TimeOfDay
                              Required. Window start time, in the UTC timezone.
                              duration google.protobuf.Duration
                              Window duration. Acceptable values are 1h to 24h, inclusive.

                              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.

                                Update

                                Updates the specified node group.

                                rpc Update (UpdateNodeGroupRequest) returns (operation.Operation)

                                Metadata and response of Operation:

                                    Operation.metadata:UpdateNodeGroupMetadata

                                    Operation.response:NodeGroup

                                UpdateNodeGroupRequest

                                Field Description
                                node_group_id string
                                Required. ID of the node group to update. To get the node group ID use a NodeGroupService.List request.
                                update_mask google.protobuf.FieldMask
                                Field mask that specifies which fields of the node group are going to be updated.
                                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 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]*.
                                node_template NodeTemplate
                                Node template for the node group. Change may trigger nodes rolling reboot or recreate.
                                scale_policy ScalePolicy
                                Scale policy of the node group.
                                allocation_policy NodeGroupAllocationPolicy
                                Allocation policy of the node group by the zones and regions.
                                deploy_policy 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.
                                maintenance_policy NodeGroupMaintenancePolicy
                                Maintenance policy of the node group.
                                allowed_unsafe_sysctls[] 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*].
                                node_taints[] Taint
                                Taints that are applied to the nodes of the node group at creation time.
                                node_labels map<string,string>
                                Labels that are assigned to the nodes of the node group at creation time.

                                NodeTemplate

                                Field Description
                                platform_id string
                                ID of the hardware platform configuration for the node.
                                resources_spec ResourcesSpec
                                Computing resources of the node such as the amount of memory and number of cores.
                                boot_disk_spec DiskSpec
                                Specification for the boot disk that will be attached to the node.
                                metadata map<string,string>
                                The metadata as key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.
                                For example, you may use the metadata in order to provide your public SSH key to the node. For more information, see Metadata. 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]*.
                                v4_address_spec NodeAddressSpec
                                Specification for the create network interfaces for the node group compute instances. Deprecated, please use network_interface_specs.
                                scheduling_policy SchedulingPolicy
                                Scheduling policy configuration.
                                network_interface_specs[] NetworkInterfaceSpec
                                New api, to specify network interfaces for the node group compute instances. Can not be used together with 'v4_address_spec'

                                ResourcesSpec

                                Field Description
                                memory int64
                                Amount of memory available to the node, specified in bytes. The minimum value is 0.
                                cores int64
                                Number of cores available to the node. The minimum value is 0.
                                core_fraction 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 int64
                                Number of GPUs available to the node. The minimum value is 0.

                                DiskSpec

                                Field Description
                                disk_type_id string
                                ID of the disk type. Value must match the regular expression |network-ssd|network-hdd.
                                disk_size int64
                                Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive.

                                NodeAddressSpec

                                Field Description
                                one_to_one_nat_spec 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.

                                OneToOneNatSpec

                                Field Description
                                ip_version enum IpVersion
                                IP version for the public IP address.
                                • IPV4: IPv4 address, for example 192.168.0.0.
                                • IPV6: IPv6 address, not available yet.

                                  SchedulingPolicy

                                  Field Description
                                  preemptible bool
                                  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
                                  subnet_ids[] string
                                  IDs of the subnets.
                                  primary_v4_address_spec NodeAddressSpec
                                  Primary IPv4 address that is assigned to the instance for this network interface.
                                  primary_v6_address_spec NodeAddressSpec
                                  Primary IPv6 address that is assigned to the instance for this network interface.
                                  security_group_ids[] string
                                  IDs of security groups.

                                  NodeAddressSpec

                                  Field Description
                                  one_to_one_nat_spec 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.

                                  OneToOneNatSpec

                                  Field Description
                                  ip_version enum IpVersion
                                  IP version for the public IP address.
                                  • IPV4: IPv4 address, for example 192.168.0.0.
                                  • IPV6: IPv6 address, not available yet.

                                    ScalePolicy

                                    Field Description
                                    scale_type oneof: fixed_scale or auto_scale
                                      fixed_scale FixedScale
                                    Fixed scale policy of the node group.
                                      auto_scale AutoScale
                                    Auto scale policy of the node group.

                                    FixedScale

                                    Field Description
                                    size int64
                                    Number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

                                    AutoScale

                                    Field Description
                                    min_size int64
                                    Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                                    max_size int64
                                    Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                                    initial_size 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
                                    zone_id string
                                    Required. ID of the availability zone where the nodes may reside.
                                    subnet_id 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
                                    max_unavailable 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 max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.
                                    max_expansion int64
                                    The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.

                                    UpdateVersionSpec

                                    Field Description
                                    specifier oneof: version or latest_revision
                                      version string
                                    Request update to a newer version of Kubernetes (1.x -> 1.y).
                                      latest_revision bool
                                    Request update to the latest revision for the current version.

                                    NodeGroupMaintenancePolicy

                                    Field Description
                                    auto_upgrade bool
                                    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.
                                    auto_repair bool
                                    If set to true, automatic repairs are enabled. Default value is false.
                                    maintenance_window 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
                                    policy oneof: anytime, daily_maintenance_window or weekly_maintenance_window
                                    Maintenance policy.
                                      anytime AnytimeMaintenanceWindow
                                    Updating the master at any time.
                                      daily_maintenance_window DailyMaintenanceWindow
                                    Updating the master on any day during the specified time window.
                                      weekly_maintenance_window WeeklyMaintenanceWindow
                                    Updating the master on selected days during the specified time window.

                                    AnytimeMaintenanceWindow

                                    DailyMaintenanceWindow

                                    Field Description
                                    start_time google.type.TimeOfDay
                                    Required. Window start time, in the UTC timezone.
                                    duration google.protobuf.Duration
                                    Window duration. Acceptable values are 1h to 24h, inclusive.

                                    WeeklyMaintenanceWindow

                                    Field Description
                                    days_of_week[] 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[] google.type.DayOfWeek
                                    Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7.
                                    start_time google.type.TimeOfDay
                                    Required. Window start time, in the UTC timezone.
                                    duration google.protobuf.Duration
                                    Window duration. Acceptable values are 1h to 24h, inclusive.

                                    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.

                                      Operation

                                      Field Description
                                      id string
                                      ID of the operation.
                                      description string
                                      Description of the operation. 0-256 characters long.
                                      created_at google.protobuf.Timestamp
                                      Creation timestamp.
                                      created_by string
                                      ID of the user or service account who initiated the operation.
                                      modified_at google.protobuf.Timestamp
                                      The time when the Operation resource was last modified.
                                      done bool
                                      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 google.protobuf.Any<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.
                                      result oneof: error or 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.
                                        error google.rpc.Status
                                      The error result of the operation in case of failure or cancellation.
                                        response google.protobuf.Any<NodeGroup>
                                      if operation finished successfully.

                                      UpdateNodeGroupMetadata

                                      Field Description
                                      node_group_id string
                                      Required. ID of the Node group that is being updated.

                                      NodeGroup

                                      Field Description
                                      id string
                                      ID of the node group.
                                      cluster_id string
                                      ID of the cluster that the node group belongs to.
                                      created_at google.protobuf.Timestamp
                                      Creation timestamp.
                                      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 map<string,string>
                                      Resource labels as key:value pairs. Мaximum 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.
                                        node_template NodeTemplate
                                        Node template that specifies parameters of the compute instances for the node group.
                                        scale_policy ScalePolicy
                                        Scale policy of the node group. For more information, see Scaling policy.
                                        allocation_policy NodeGroupAllocationPolicy
                                        Allocation policy by which resources for node group are allocated to zones and regions.
                                        deploy_policy DeployPolicy
                                        Deploy policy according to which the updates are rolled out.
                                        instance_group_id string
                                        ID of the managed instance group associated with this node group.
                                        node_version string
                                        Version of Kubernetes components that runs on the nodes. Deprecated. Use version_info.current_version.
                                        version_info VersionInfo
                                        Detailed information about the Kubernetes version that is running on the node.
                                        maintenance_policy NodeGroupMaintenancePolicy
                                        Maintenance policy of the node group.
                                        allowed_unsafe_sysctls[] string
                                        Support for unsafe sysctl parameters. For more details see documentation.
                                        node_taints[] Taint
                                        Taints that are applied to the nodes of the node group at creation time.
                                        node_labels map<string,string>
                                        Labels that are assigned to the nodes of the node group at creation time.

                                        NodeTemplate

                                        Field Description
                                        platform_id string
                                        ID of the hardware platform configuration for the node.
                                        resources_spec ResourcesSpec
                                        Computing resources of the node such as the amount of memory and number of cores.
                                        boot_disk_spec DiskSpec
                                        Specification for the boot disk that will be attached to the node.
                                        metadata map<string,string>
                                        The metadata as key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.
                                        For example, you may use the metadata in order to provide your public SSH key to the node. For more information, see Metadata. 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]*.
                                        v4_address_spec NodeAddressSpec
                                        Specification for the create network interfaces for the node group compute instances. Deprecated, please use network_interface_specs.
                                        scheduling_policy SchedulingPolicy
                                        Scheduling policy configuration.
                                        network_interface_specs[] NetworkInterfaceSpec
                                        New api, to specify network interfaces for the node group compute instances. Can not be used together with 'v4_address_spec'

                                        ResourcesSpec

                                        Field Description
                                        memory int64
                                        Amount of memory available to the node, specified in bytes. The minimum value is 0.
                                        cores int64
                                        Number of cores available to the node. The minimum value is 0.
                                        core_fraction 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 int64
                                        Number of GPUs available to the node. The minimum value is 0.

                                        DiskSpec

                                        Field Description
                                        disk_type_id string
                                        ID of the disk type. Value must match the regular expression |network-ssd|network-hdd.
                                        disk_size int64
                                        Size of the disk, specified in bytes. Acceptable values are 0 to 4398046511104, inclusive.

                                        NodeAddressSpec

                                        Field Description
                                        one_to_one_nat_spec 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.

                                        OneToOneNatSpec

                                        Field Description
                                        ip_version enum IpVersion
                                        IP version for the public IP address.
                                        • IPV4: IPv4 address, for example 192.168.0.0.
                                        • IPV6: IPv6 address, not available yet.

                                          SchedulingPolicy

                                          Field Description
                                          preemptible bool
                                          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
                                          subnet_ids[] string
                                          IDs of the subnets.
                                          primary_v4_address_spec NodeAddressSpec
                                          Primary IPv4 address that is assigned to the instance for this network interface.
                                          primary_v6_address_spec NodeAddressSpec
                                          Primary IPv6 address that is assigned to the instance for this network interface.
                                          security_group_ids[] string
                                          IDs of security groups.

                                          NodeAddressSpec

                                          Field Description
                                          one_to_one_nat_spec 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.

                                          OneToOneNatSpec

                                          Field Description
                                          ip_version enum IpVersion
                                          IP version for the public IP address.
                                          • IPV4: IPv4 address, for example 192.168.0.0.
                                          • IPV6: IPv6 address, not available yet.

                                            ScalePolicy

                                            Field Description
                                            scale_type oneof: fixed_scale or auto_scale
                                              fixed_scale FixedScale
                                            Fixed scale policy of the node group.
                                              auto_scale AutoScale
                                            Auto scale policy of the node group.

                                            FixedScale

                                            Field Description
                                            size int64
                                            Number of nodes in the node group. Acceptable values are 0 to 100, inclusive.

                                            AutoScale

                                            Field Description
                                            min_size int64
                                            Minimum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                                            max_size int64
                                            Maximum number of nodes in the node group. Acceptable values are 0 to 100, inclusive.
                                            initial_size 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
                                            zone_id string
                                            Required. ID of the availability zone where the nodes may reside.
                                            subnet_id 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
                                            max_unavailable 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 max_expansion is not specified or set to zero, max_unavailable must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.
                                            max_expansion int64
                                            The maximum number of instances that can be temporarily allocated above the group's target size during the update process. If max_unavailable is not specified or set to zero, max_expansion must be set to a non-zero value. Acceptable values are 0 to 100, inclusive.

                                            VersionInfo

                                            Field Description
                                            current_version string
                                            Current Kubernetes version, format: major.minor (e.g. 1.15).
                                            new_revision_available bool
                                            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 Yandex specific components either on the master or nodes.
                                            new_revision_summary string
                                            Description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
                                            version_deprecated bool
                                            The current version is on the deprecation schedule, component (master or node group) should be upgraded.

                                            NodeGroupMaintenancePolicy

                                            Field Description
                                            auto_upgrade bool
                                            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.
                                            auto_repair bool
                                            If set to true, automatic repairs are enabled. Default value is false.
                                            maintenance_window 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
                                            policy oneof: anytime, daily_maintenance_window or weekly_maintenance_window
                                            Maintenance policy.
                                              anytime AnytimeMaintenanceWindow
                                            Updating the master at any time.
                                              daily_maintenance_window DailyMaintenanceWindow
                                            Updating the master on any day during the specified time window.
                                              weekly_maintenance_window WeeklyMaintenanceWindow
                                            Updating the master on selected days during the specified time window.

                                            AnytimeMaintenanceWindow

                                            DailyMaintenanceWindow

                                            Field Description
                                            start_time google.type.TimeOfDay
                                            Required. Window start time, in the UTC timezone.
                                            duration google.protobuf.Duration
                                            Window duration. Acceptable values are 1h to 24h, inclusive.

                                            WeeklyMaintenanceWindow

                                            Field Description
                                            days_of_week[] 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[] google.type.DayOfWeek
                                            Days of the week when automatic updates are allowed. The number of elements must be in the range 1-7.
                                            start_time google.type.TimeOfDay
                                            Required. Window start time, in the UTC timezone.
                                            duration google.protobuf.Duration
                                            Window duration. Acceptable values are 1h to 24h, inclusive.

                                            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.

                                              Delete

                                              Deletes the specified node group.

                                              rpc Delete (DeleteNodeGroupRequest) returns (operation.Operation)

                                              Metadata and response of Operation:

                                                  Operation.metadata:DeleteNodeGroupMetadata

                                                  Operation.response:google.protobuf.Empty

                                              DeleteNodeGroupRequest

                                              Field Description
                                              node_group_id string
                                              Required. ID of the node group to delete. To get node group ID use a NodeGroupService.List request.

                                              Operation

                                              Field Description
                                              id string
                                              ID of the operation.
                                              description string
                                              Description of the operation. 0-256 characters long.
                                              created_at google.protobuf.Timestamp
                                              Creation timestamp.
                                              created_by string
                                              ID of the user or service account who initiated the operation.
                                              modified_at google.protobuf.Timestamp
                                              The time when the Operation resource was last modified.
                                              done bool
                                              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 google.protobuf.Any<DeleteNodeGroupMetadata>
                                              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.
                                              result oneof: error or 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.
                                                error google.rpc.Status
                                              The error result of the operation in case of failure or cancellation.
                                                response google.protobuf.Any<google.protobuf.Empty>
                                              if operation finished successfully.

                                              DeleteNodeGroupMetadata

                                              Field Description
                                              node_group_id string
                                              ID of the node group that is being deleted.

                                              ListOperations

                                              Lists operations for the specified node group.

                                              rpc ListOperations (ListNodeGroupOperationsRequest) returns (ListNodeGroupOperationsResponse)

                                              ListNodeGroupOperationsRequest

                                              Field Description
                                              node_group_id string
                                              Required. ID of the node group to list operations for.
                                              page_size int64
                                              The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListNodeGroupOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
                                              page_token string
                                              Page token. To get the next page of results, set page_token to the ListNodeGroupOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
                                              filter string
                                              A filter expression that filters resources listed in the response. Currently you can use filtering only on NodeGroup.name field. The maximum string length in characters is 1000.

                                              ListNodeGroupOperationsResponse

                                              Field Description
                                              operations[] operation.Operation
                                              List of operations for the specified node group.
                                              next_page_token string
                                              This token allows you to get the next page of results for list requests. If the number of results is larger than ListNodeGroupOperationsRequest.page_size, use the next_page_token as the value for the ListNodeGroupOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

                                              Operation

                                              Field Description
                                              id string
                                              ID of the operation.
                                              description string
                                              Description of the operation. 0-256 characters long.
                                              created_at google.protobuf.Timestamp
                                              Creation timestamp.
                                              created_by string
                                              ID of the user or service account who initiated the operation.
                                              modified_at google.protobuf.Timestamp
                                              The time when the Operation resource was last modified.
                                              done bool
                                              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 google.protobuf.Any
                                              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.
                                              result oneof: error or 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.
                                                error google.rpc.Status
                                              The error result of the operation in case of failure or cancellation.
                                                response google.protobuf.Any
                                              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.

                                              ListNodes

                                              Retrieves the list of nodes in the specified Kubernetes cluster.

                                              rpc ListNodes (ListNodeGroupNodesRequest) returns (ListNodeGroupNodesResponse)

                                              ListNodeGroupNodesRequest

                                              Field Description
                                              node_group_id string
                                              Required. ID of the node group to list. To get the node group ID use a NodeGroupService.List request.
                                              page_size int64
                                              The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListNodeGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
                                              page_token string
                                              Page token. To get the next page of results, set page_token to the ListNodeGroupNodesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

                                              ListNodeGroupNodesResponse

                                              Field Description
                                              nodes[] Node
                                              List of nodes.
                                              next_page_token string
                                              This token allows you to get the next page of results for list requests. If the number of results is larger than ListNodeGroupNodesRequest.page_size, use the next_page_token as the value for the ListNodeGroupNodesRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

                                              Node

                                              Field Description
                                              status enum Status
                                              Computed node status.
                                              • PROVISIONING: Node instance is not yet created (e.g. in progress).
                                              • NOT_CONNECTED: Node instance is created but not registered (e.g. is still initializing).
                                              • NOT_READY: Node has connected but is not ready for workload (see conditions for details).
                                              • READY: Node has connected and ready for workload.
                                              • MISSING: Node is still registered but its instance is deleted (this is our bug).
                                                spec Spec
                                                Node specificaion.
                                                cloud_status CloudStatus
                                                Cloud instance status. Not available in MISSING status.
                                                kubernetes_status KubernetesStatus
                                                Kubernetes node status. Not available in PROVISIONING and NOT_CONNECTED states.

                                                KubernetesStatus

                                                Field Description
                                                id string
                                                Node id (and instance name)
                                                conditions[] Condition
                                                Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition
                                                taints[] Taint
                                                If specified, the node's taints.
                                                attached_volumes[] AttachedVolume
                                                List of volumes that are attached to the node.

                                                CloudStatus

                                                Field Description
                                                id string
                                                Compute instance id
                                                status string
                                                IG instance status
                                                status_message string
                                                IG instance status message

                                                Spec

                                                Field Description
                                                resources ResourcesSpec
                                                Node group specified resources.
                                                disk DiskSpec
                                                Node group specified disk.
                                                In this article:
                                                • Calls NodeGroupService
                                                • Get
                                                • GetNodeGroupRequest
                                                • NodeGroup
                                                • NodeTemplate
                                                • ResourcesSpec
                                                • DiskSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • SchedulingPolicy
                                                • NetworkInterfaceSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • ScalePolicy
                                                • FixedScale
                                                • AutoScale
                                                • NodeGroupAllocationPolicy
                                                • NodeGroupLocation
                                                • DeployPolicy
                                                • VersionInfo
                                                • NodeGroupMaintenancePolicy
                                                • MaintenanceWindow
                                                • AnytimeMaintenanceWindow
                                                • DailyMaintenanceWindow
                                                • WeeklyMaintenanceWindow
                                                • DaysOfWeekMaintenanceWindow
                                                • Taint
                                                • List
                                                • ListNodeGroupsRequest
                                                • ListNodeGroupsResponse
                                                • NodeGroup
                                                • NodeTemplate
                                                • ResourcesSpec
                                                • DiskSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • SchedulingPolicy
                                                • NetworkInterfaceSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • ScalePolicy
                                                • FixedScale
                                                • AutoScale
                                                • NodeGroupAllocationPolicy
                                                • NodeGroupLocation
                                                • DeployPolicy
                                                • VersionInfo
                                                • NodeGroupMaintenancePolicy
                                                • MaintenanceWindow
                                                • AnytimeMaintenanceWindow
                                                • DailyMaintenanceWindow
                                                • WeeklyMaintenanceWindow
                                                • DaysOfWeekMaintenanceWindow
                                                • Taint
                                                • Create
                                                • CreateNodeGroupRequest
                                                • NodeTemplate
                                                • ResourcesSpec
                                                • DiskSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • SchedulingPolicy
                                                • NetworkInterfaceSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • ScalePolicy
                                                • FixedScale
                                                • AutoScale
                                                • NodeGroupAllocationPolicy
                                                • NodeGroupLocation
                                                • DeployPolicy
                                                • NodeGroupMaintenancePolicy
                                                • MaintenanceWindow
                                                • AnytimeMaintenanceWindow
                                                • DailyMaintenanceWindow
                                                • WeeklyMaintenanceWindow
                                                • DaysOfWeekMaintenanceWindow
                                                • Taint
                                                • Operation
                                                • CreateNodeGroupMetadata
                                                • NodeGroup
                                                • NodeTemplate
                                                • ResourcesSpec
                                                • DiskSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • SchedulingPolicy
                                                • NetworkInterfaceSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • ScalePolicy
                                                • FixedScale
                                                • AutoScale
                                                • NodeGroupAllocationPolicy
                                                • NodeGroupLocation
                                                • DeployPolicy
                                                • VersionInfo
                                                • NodeGroupMaintenancePolicy
                                                • MaintenanceWindow
                                                • AnytimeMaintenanceWindow
                                                • DailyMaintenanceWindow
                                                • WeeklyMaintenanceWindow
                                                • DaysOfWeekMaintenanceWindow
                                                • Taint
                                                • Update
                                                • UpdateNodeGroupRequest
                                                • NodeTemplate
                                                • ResourcesSpec
                                                • DiskSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • SchedulingPolicy
                                                • NetworkInterfaceSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • ScalePolicy
                                                • FixedScale
                                                • AutoScale
                                                • NodeGroupAllocationPolicy
                                                • NodeGroupLocation
                                                • DeployPolicy
                                                • UpdateVersionSpec
                                                • NodeGroupMaintenancePolicy
                                                • MaintenanceWindow
                                                • AnytimeMaintenanceWindow
                                                • DailyMaintenanceWindow
                                                • WeeklyMaintenanceWindow
                                                • DaysOfWeekMaintenanceWindow
                                                • Taint
                                                • Operation
                                                • UpdateNodeGroupMetadata
                                                • NodeGroup
                                                • NodeTemplate
                                                • ResourcesSpec
                                                • DiskSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • SchedulingPolicy
                                                • NetworkInterfaceSpec
                                                • NodeAddressSpec
                                                • OneToOneNatSpec
                                                • ScalePolicy
                                                • FixedScale
                                                • AutoScale
                                                • NodeGroupAllocationPolicy
                                                • NodeGroupLocation
                                                • DeployPolicy
                                                • VersionInfo
                                                • NodeGroupMaintenancePolicy
                                                • MaintenanceWindow
                                                • AnytimeMaintenanceWindow
                                                • DailyMaintenanceWindow
                                                • WeeklyMaintenanceWindow
                                                • DaysOfWeekMaintenanceWindow
                                                • Taint
                                                • Delete
                                                • DeleteNodeGroupRequest
                                                • Operation
                                                • DeleteNodeGroupMetadata
                                                • ListOperations
                                                • ListNodeGroupOperationsRequest
                                                • ListNodeGroupOperationsResponse
                                                • Operation
                                                • ListNodes
                                                • ListNodeGroupNodesRequest
                                                • ListNodeGroupNodesResponse
                                                • Node
                                                • KubernetesStatus
                                                • CloudStatus
                                                • Spec
                                                Language
                                                Careers
                                                Privacy policy
                                                Terms of use
                                                © 2021 Yandex.Cloud LLC