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

ClusterService

Набор методов для управления кластером Kubernetes.

Вызов Описание
Get Возвращает указанный кластер Kubernetes.
List Возвращает список кластеров Kubernetes в указанном каталоге.
Create Создает кластер Kubernetes в указанном каталоге.
Update Обновляет указанный кластер Kubernetes.
Delete Удаляет указанный кластер Kubernetes.
Stop Останавливает указанный кластер Kubernetes.
Start Запускает указанный кластер Kubernetes.
ListNodeGroups Список групп узлов для указанного кластера Kubernetes.
ListOperations Список операций для указанного кластера Kubernetes.

Вызовы ClusterService

Get

Возвращает указанный кластер Kubernetes.
Чтобы получить список доступных кластеров Kubernetes, сделайте запрос List.

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор возвращаемого кластера Kubernetes.

Cluster

Поле Описание
id string
Идентификатор кластера Kubernetes.
folder_id string
Идентификатор каталога, которому принадлежит кластер Kubernetes.
created_at google.protobuf.Timestamp
Время создания.
name string
Имя кластера Kubernetes.
description string
Описание кластера Kubernetes. Длина описания должна быть от 0 до 256 символов.
labels map<string,string>
Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
status enum Status
Статус кластера Kubernetes.
  • PROVISIONING: Кластер Kubernetes ожидает выделения ресурсов.
  • RUNNING: Кластер Kubernetes запущен.
  • RECONCILING: Кластер Kubernetes согласовывается.
  • STOPPING: Кластер Kubernetes останавливается.
  • STOPPED: Кластер Kubernetes остановлен.
  • DELETING: Кластер Kubernetes удаляется.
  • STARTING: Кластер Kubernetes запускается.
    health enum Health
    Состояние кластера Kubernetes.
    • HEALTHY: Кластер Kubernetes работает нормально.
    • UNHEALTHY: Кластер Kubernetes не работает и не может выполнять свои основные функции.
      network_id string
      Идентификатор облачной сети, к которой принадлежит кластер Kubernetes.
      master Master
      Свойства мастера для кластера Kubernetes.
      ip_allocation_policy IPAllocationPolicy
      Политика распределения IP-адресов для служб и модулей внутри кластера Kubernetes в разных зонах доступности.
      internet_gateway oneof: gateway_ipv4_address
        gateway_ipv4_address string
      Адрес шлюза IPv4. Максимальная длина строки в символах — 15.
      service_account_id string
      Сервисный аккаунт, используемый для выделения Compute Cloud и VPC ресурсов для кластера Kubernetes.
      node_service_account_id string
      Сервисный аккаунт, используемый узлами кластера Kubernetes для доступа к Container Registry или для загрузки логов и метрик узла.
      release_channel enum ReleaseChannel
      При создании кластера Kubernetes вы должны указать один из трех релизных каналов. Релизный канал содержит несколько версий Kubernetes. Каналы отличаются набором доступных версий, управлением автоматическими обновлениями и получаемыми обновлениями. Изменить канал после создания кластера Kubernetes нельзя, возможно только пересоздать кластер Kubernetes и указать новый релизный канал. Дополнительные сведения см. в documentation.
      • RAPID: На канале часто появляются минорные обновления, содержащие новую функциональность и улучшения. Вы не можете отключить автоматическое обновление на этом канале, но вы можете указать период времени для автоматического обновления.
      • REGULAR: Новая функциональность и улучшения порциями попадают на канал через некоторое время после того, как были предоставлены на канале RAPID.
      • STABLE: На канале происходят только обновления, касающиеся исправление ошибок или улучшения безопасности.
        network_policy NetworkPolicy

        Master

        Поле Описание
        master_type oneof: zonal_master или regional_master
          zonal_master ZonalMaster
        Параметры зоны доступности мастера.
          regional_master RegionalMaster
        Параметры региона для мастера.
        version string
        Версия компонентов Kubernetes, которая запущена на мастере.
        endpoints MasterEndpoints
        Эндпойнт мастера. Эндпойнты состоят из схемы и порта (т. е. https://ip-address:port) и могут использоваться клиентами для связи с API Kubernetes кластера Kubernetes.
        master_auth MasterAuth
        Параметры, используемые для аутентификации мастера.
        version_info VersionInfo
        Подробная информация о версии Kubernetes, которая запущена на мастере.
        maintenance_policy MasterMaintenancePolicy
        Политика обновления мастера.

        ZonalMaster

        Поле Описание
        zone_id string
        Идентификатор зоны доступности, в которой находится мастер.
        internal_v4_address string
        Внутренний IPv4-адрес, назначенный мастеру.
        external_v4_address string
        Внешний IPv4-адрес, назначенный мастеру.

        RegionalMaster

        Поле Описание
        region_id string
        Идентификатор региона, в котором находится мастер.
        internal_v4_address string
        Внутренний IPv4-адрес, назначенный мастеру.
        external_v4_address string
        Внешний IPv4-адрес, назначенный мастеру.

        MasterEndpoints

        Поле Описание
        internal_v4_endpoint string
        Внутренний эндпойнт, который может использоваться для подключения к мастеру из облачных сетей.
        external_v4_endpoint string
        Внешний эндпойнт, который может использоваться для доступа к API кластера Kubernetes из интернета (вне Облака).

        MasterAuth

        Поле Описание
        cluster_ca_certificate string
        Публичный PEM-закодированный сертификат, подтверждающий подлинность кластера Kubernetes.

        VersionInfo

        Поле Описание
        current_version string
        Текущая версия Kubernetes, формат: major.minor (например, 1.15).
        new_revision_available bool
        Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах.
        new_revision_summary string
        Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false.
        version_deprecated bool
        Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен.

        MasterMaintenancePolicy

        Поле Описание
        auto_upgrade bool
        Если установлено значение true, автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false, автоматическое обновление отключено.
        maintenance_window MaintenanceWindow
        Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.

        MaintenanceWindow

        Поле Описание
        policy oneof: anytime, daily_maintenance_window или weekly_maintenance_window
        Политика обновления.
          anytime AnytimeMaintenanceWindow
        Обновление мастера в любое время.
          daily_maintenance_window DailyMaintenanceWindow
        Обновление мастера в любой день в течение указанного временного окна.
          weekly_maintenance_window WeeklyMaintenanceWindow
        Обновление мастера в выбранные дни в течение указанного временного окна.

        AnytimeMaintenanceWindow

        DailyMaintenanceWindow

        Поле Описание
        start_time google.type.TimeOfDay
        Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
        duration google.protobuf.Duration
        Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

        WeeklyMaintenanceWindow

        Поле Описание
        days_of_week[] DaysOfWeekMaintenanceWindow
        Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.

        DaysOfWeekMaintenanceWindow

        Поле Описание
        days[] google.type.DayOfWeek
        Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.
        start_time google.type.TimeOfDay
        Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
        duration google.protobuf.Duration
        Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

        IPAllocationPolicy

        Поле Описание
        cluster_ipv4_cidr_block string
        CIDR. Диапазон IP-адресов для подов.
        Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes. Статические маршруты будут настроены для этих блоков CIDR в подсетях узлов.
        service_ipv4_cidr_block string
        CIDR. Диапазон IP-адресов для сервисов.
        Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes.

        NetworkPolicy

        Поле Описание
        provider enum Provider

          List

          Возвращает список кластеров Kubernetes в указанном каталоге.

          rpc List (ListClustersRequest) returns (ListClustersResponse)

          ListClustersRequest

          Поле Описание
          folder_id string
          Обязательное поле. Идентификатор каталога для получения списка кластеров Kubernetes. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List.
          page_size int64
          Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClustersResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
          page_token string
          Токен страницы. Установите значение page_token равным значению поля ListClustersResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
          filter string
          1. Имя поля. В настоящее время фильтрация осуществляется только по полю Cluster.name.
          2. Оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений.
          3. Значение. Значение длиной от 1 до 61 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9]$.
          Максимальная длина строки в символах — 1000.

          ListClustersResponse

          Поле Описание
          clusters[] Cluster
          Список кластеров Kubernetes.
          next_page_token string
          Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClustersRequest.page_size, используйте next_page_token в качестве значения параметра ListClustersRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

          Cluster

          Поле Описание
          id string
          Идентификатор кластера Kubernetes.
          folder_id string
          Идентификатор каталога, которому принадлежит кластер Kubernetes.
          created_at google.protobuf.Timestamp
          Время создания.
          name string
          Имя кластера Kubernetes.
          description string
          Описание кластера Kubernetes. Длина описания должна быть от 0 до 256 символов.
          labels map<string,string>
          Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
          status enum Status
          Статус кластера Kubernetes.
          • PROVISIONING: Кластер Kubernetes ожидает выделения ресурсов.
          • RUNNING: Кластер Kubernetes запущен.
          • RECONCILING: Кластер Kubernetes согласовывается.
          • STOPPING: Кластер Kubernetes останавливается.
          • STOPPED: Кластер Kubernetes остановлен.
          • DELETING: Кластер Kubernetes удаляется.
          • STARTING: Кластер Kubernetes запускается.
            health enum Health
            Состояние кластера Kubernetes.
            • HEALTHY: Кластер Kubernetes работает нормально.
            • UNHEALTHY: Кластер Kubernetes не работает и не может выполнять свои основные функции.
              network_id string
              Идентификатор облачной сети, к которой принадлежит кластер Kubernetes.
              master Master
              Свойства мастера для кластера Kubernetes.
              ip_allocation_policy IPAllocationPolicy
              Политика распределения IP-адресов для служб и модулей внутри кластера Kubernetes в разных зонах доступности.
              internet_gateway oneof: gateway_ipv4_address
                gateway_ipv4_address string
              Адрес шлюза IPv4. Максимальная длина строки в символах — 15.
              service_account_id string
              Сервисный аккаунт, используемый для выделения Compute Cloud и VPC ресурсов для кластера Kubernetes.
              node_service_account_id string
              Сервисный аккаунт, используемый узлами кластера Kubernetes для доступа к Container Registry или для загрузки логов и метрик узла.
              release_channel enum ReleaseChannel
              При создании кластера Kubernetes вы должны указать один из трех релизных каналов. Релизный канал содержит несколько версий Kubernetes. Каналы отличаются набором доступных версий, управлением автоматическими обновлениями и получаемыми обновлениями. Изменить канал после создания кластера Kubernetes нельзя, возможно только пересоздать кластер Kubernetes и указать новый релизный канал. Дополнительные сведения см. в documentation.
              • RAPID: На канале часто появляются минорные обновления, содержащие новую функциональность и улучшения. Вы не можете отключить автоматическое обновление на этом канале, но вы можете указать период времени для автоматического обновления.
              • REGULAR: Новая функциональность и улучшения порциями попадают на канал через некоторое время после того, как были предоставлены на канале RAPID.
              • STABLE: На канале происходят только обновления, касающиеся исправление ошибок или улучшения безопасности.
                network_policy NetworkPolicy

                Master

                Поле Описание
                master_type oneof: zonal_master или regional_master
                  zonal_master ZonalMaster
                Параметры зоны доступности мастера.
                  regional_master RegionalMaster
                Параметры региона для мастера.
                version string
                Версия компонентов Kubernetes, которая запущена на мастере.
                endpoints MasterEndpoints
                Эндпойнт мастера. Эндпойнты состоят из схемы и порта (т. е. https://ip-address:port) и могут использоваться клиентами для связи с API Kubernetes кластера Kubernetes.
                master_auth MasterAuth
                Параметры, используемые для аутентификации мастера.
                version_info VersionInfo
                Подробная информация о версии Kubernetes, которая запущена на мастере.
                maintenance_policy MasterMaintenancePolicy
                Политика обновления мастера.

                ZonalMaster

                Поле Описание
                zone_id string
                Идентификатор зоны доступности, в которой находится мастер.
                internal_v4_address string
                Внутренний IPv4-адрес, назначенный мастеру.
                external_v4_address string
                Внешний IPv4-адрес, назначенный мастеру.

                RegionalMaster

                Поле Описание
                region_id string
                Идентификатор региона, в котором находится мастер.
                internal_v4_address string
                Внутренний IPv4-адрес, назначенный мастеру.
                external_v4_address string
                Внешний IPv4-адрес, назначенный мастеру.

                MasterEndpoints

                Поле Описание
                internal_v4_endpoint string
                Внутренний эндпойнт, который может использоваться для подключения к мастеру из облачных сетей.
                external_v4_endpoint string
                Внешний эндпойнт, который может использоваться для доступа к API кластера Kubernetes из интернета (вне Облака).

                MasterAuth

                Поле Описание
                cluster_ca_certificate string
                Публичный PEM-закодированный сертификат, подтверждающий подлинность кластера Kubernetes.

                VersionInfo

                Поле Описание
                current_version string
                Текущая версия Kubernetes, формат: major.minor (например, 1.15).
                new_revision_available bool
                Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах.
                new_revision_summary string
                Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false.
                version_deprecated bool
                Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен.

                MasterMaintenancePolicy

                Поле Описание
                auto_upgrade bool
                Если установлено значение true, автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false, автоматическое обновление отключено.
                maintenance_window MaintenanceWindow
                Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.

                MaintenanceWindow

                Поле Описание
                policy oneof: anytime, daily_maintenance_window или weekly_maintenance_window
                Политика обновления.
                  anytime AnytimeMaintenanceWindow
                Обновление мастера в любое время.
                  daily_maintenance_window DailyMaintenanceWindow
                Обновление мастера в любой день в течение указанного временного окна.
                  weekly_maintenance_window WeeklyMaintenanceWindow
                Обновление мастера в выбранные дни в течение указанного временного окна.

                AnytimeMaintenanceWindow

                DailyMaintenanceWindow

                Поле Описание
                start_time google.type.TimeOfDay
                Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                duration google.protobuf.Duration
                Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                WeeklyMaintenanceWindow

                Поле Описание
                days_of_week[] DaysOfWeekMaintenanceWindow
                Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.

                DaysOfWeekMaintenanceWindow

                Поле Описание
                days[] google.type.DayOfWeek
                Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.
                start_time google.type.TimeOfDay
                Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                duration google.protobuf.Duration
                Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                IPAllocationPolicy

                Поле Описание
                cluster_ipv4_cidr_block string
                CIDR. Диапазон IP-адресов для подов.
                Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes. Статические маршруты будут настроены для этих блоков CIDR в подсетях узлов.
                service_ipv4_cidr_block string
                CIDR. Диапазон IP-адресов для сервисов.
                Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes.

                NetworkPolicy

                Поле Описание
                provider enum Provider

                  Create

                  Создает кластер Kubernetes в указанном каталоге.

                  rpc Create (CreateClusterRequest) returns (operation.Operation)

                  Метаданные и результат операции:

                      Operation.metadata:CreateClusterMetadata

                      Operation.response:Cluster

                  CreateClusterRequest

                  Поле Описание
                  folder_id string
                  Обязательное поле. Идентификатор каталога, в котором нужно создать кластер Kubernetes. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List.
                  name string
                  Имя кластера Kubernetes. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
                  description string
                  Описание кластера Kubernetes. Максимальная длина строки в символах — 256.
                  labels map<string,string>
                  Метки ресурса в формате key:value. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
                  network_id string
                  Обязательное поле. Идентификатор облачной сети.
                  master_spec MasterSpec
                  Обязательное поле. Политика распределения кластера Kubernetes.
                  ip_allocation_policy IPAllocationPolicy
                  Политика распределения кластера Kubernetes.
                  internet_gateway oneof: gateway_ipv4_address
                    gateway_ipv4_address string
                  Адрес шлюза IPv4.
                  service_account_id string
                  Обязательное поле. Сервисный аккаунт, используемый для выделения Compute Cloud и VPC ресурсов для кластера Kubernetes. Выбранный сервисный аккаунт должна иметь edit роль в каталоге, в котором будет расположен кластер Kubernetes, и в каталоге, в котором находится выбранная сеть.
                  node_service_account_id string
                  Обязательное поле. Сервисный аккаунт, используемый узлами кластера Kubernetes для доступа к Container Registry или для загрузки логов и метрик узла.
                  release_channel enum ReleaseChannel
                  Релизный канал для мастера.
                  • RAPID: На канале часто появляются минорные обновления, содержащие новую функциональность и улучшения. Вы не можете отключить автоматическое обновление на этом канале, но вы можете указать период времени для автоматического обновления.
                  • REGULAR: Новая функциональность и улучшения порциями попадают на канал через некоторое время после того, как были предоставлены на канале RAPID.
                  • STABLE: На канале происходят только обновления, касающиеся исправление ошибок или улучшения безопасности.
                    network_policy NetworkPolicy

                    MasterSpec

                    Поле Описание
                    master_type oneof: zonal_master_spec или regional_master_spec
                      zonal_master_spec ZonalMasterSpec
                    Спецификация зонального мастера.
                      regional_master_spec RegionalMasterSpec
                    Спецификация регионального мастера.
                    version string
                    Версия компонентов Kubernetes, которая запущена на мастере.
                    maintenance_policy MasterMaintenancePolicy
                    Политика обновления мастера.

                    ZonalMasterSpec

                    Поле Описание
                    zone_id string
                    Обязательное поле. Идентификатор зоны доступности.
                    internal_v4_address_spec InternalAddressSpec
                    Спецификация параметров для внутренней IPv4 сети.
                    external_v4_address_spec ExternalAddressSpec
                    Спецификация параметров для внешней IPv4 сети.

                    InternalAddressSpec

                    Поле Описание
                    subnet_id string
                    Идентификатор подсети. Если идентификатор не указан, а в указанной зоне имеется только одна подсеть, адрес будет выделен в этой подсети.

                    ExternalAddressSpec

                    RegionalMasterSpec

                    Поле Описание
                    region_id string
                    Обязательное поле. Идентификатор зоны доступности, в которой находится мастер.
                    locations[] MasterLocation
                    Список местоположений (зон доступности и подсетей), в которых будут выделены ресурсы для мастера.
                    external_v4_address_spec ExternalAddressSpec
                    Указывается для выделения статического публичного IP-адреса для мастера.

                    MasterLocation

                    Поле Описание
                    zone_id string
                    Обязательное поле. Идентификатор зоны доступности.
                    internal_v4_address_spec InternalAddressSpec
                    Если параметр не указан и в указанной зоне доступности только одна подсеть, то адрес будет выделен в этой подсети.

                    InternalAddressSpec

                    Поле Описание
                    subnet_id string
                    Идентификатор подсети. Если идентификатор не указан, а в указанной зоне имеется только одна подсеть, адрес будет выделен в этой подсети.

                    ExternalAddressSpec

                    MasterMaintenancePolicy

                    Поле Описание
                    auto_upgrade bool
                    Если установлено значение true, автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false, автоматическое обновление отключено.
                    maintenance_window MaintenanceWindow
                    Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.

                    MaintenanceWindow

                    Поле Описание
                    policy oneof: anytime, daily_maintenance_window или weekly_maintenance_window
                    Политика обновления.
                      anytime AnytimeMaintenanceWindow
                    Обновление мастера в любое время.
                      daily_maintenance_window DailyMaintenanceWindow
                    Обновление мастера в любой день в течение указанного временного окна.
                      weekly_maintenance_window WeeklyMaintenanceWindow
                    Обновление мастера в выбранные дни в течение указанного временного окна.

                    AnytimeMaintenanceWindow

                    DailyMaintenanceWindow

                    Поле Описание
                    start_time google.type.TimeOfDay
                    Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                    duration google.protobuf.Duration
                    Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                    WeeklyMaintenanceWindow

                    Поле Описание
                    days_of_week[] DaysOfWeekMaintenanceWindow
                    Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.

                    DaysOfWeekMaintenanceWindow

                    Поле Описание
                    days[] google.type.DayOfWeek
                    Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.
                    start_time google.type.TimeOfDay
                    Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                    duration google.protobuf.Duration
                    Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                    IPAllocationPolicy

                    Поле Описание
                    cluster_ipv4_cidr_block string
                    CIDR. Диапазон IP-адресов для подов.
                    Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes. Статические маршруты будут настроены для этих блоков CIDR в подсетях узлов.
                    service_ipv4_cidr_block string
                    CIDR. Диапазон IP-адресов для сервисов.
                    Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes.

                    NetworkPolicy

                    Поле Описание
                    provider enum Provider

                      Operation

                      Поле Описание
                      id string
                      Идентификатор операции.
                      description string
                      Описание операции. Длина описания должна быть от 0 до 256 символов.
                      created_at google.protobuf.Timestamp
                      Время создания ресурса в формате в RFC3339.
                      created_by string
                      Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                      modified_at google.protobuf.Timestamp
                      Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                      done bool
                      Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                      metadata google.protobuf.Any<CreateClusterMetadata>
                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                      result oneof: error или response
                      Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                        error google.rpc.Status
                      Описание ошибки в случае сбоя или отмены операции.
                        response google.protobuf.Any<Cluster>
                      в случае успешного выполнения операции.

                      CreateClusterMetadata

                      Поле Описание
                      cluster_id string
                      Идентификатор создаваемого кластера Kubernetes.

                      Cluster

                      Поле Описание
                      id string
                      Идентификатор кластера Kubernetes.
                      folder_id string
                      Идентификатор каталога, которому принадлежит кластер Kubernetes.
                      created_at google.protobuf.Timestamp
                      Время создания.
                      name string
                      Имя кластера Kubernetes.
                      description string
                      Описание кластера Kubernetes. Длина описания должна быть от 0 до 256 символов.
                      labels map<string,string>
                      Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
                      status enum Status
                      Статус кластера Kubernetes.
                      • PROVISIONING: Кластер Kubernetes ожидает выделения ресурсов.
                      • RUNNING: Кластер Kubernetes запущен.
                      • RECONCILING: Кластер Kubernetes согласовывается.
                      • STOPPING: Кластер Kubernetes останавливается.
                      • STOPPED: Кластер Kubernetes остановлен.
                      • DELETING: Кластер Kubernetes удаляется.
                      • STARTING: Кластер Kubernetes запускается.
                        health enum Health
                        Состояние кластера Kubernetes.
                        • HEALTHY: Кластер Kubernetes работает нормально.
                        • UNHEALTHY: Кластер Kubernetes не работает и не может выполнять свои основные функции.
                          network_id string
                          Идентификатор облачной сети, к которой принадлежит кластер Kubernetes.
                          master Master
                          Свойства мастера для кластера Kubernetes.
                          ip_allocation_policy IPAllocationPolicy
                          Политика распределения IP-адресов для служб и модулей внутри кластера Kubernetes в разных зонах доступности.
                          internet_gateway oneof: gateway_ipv4_address
                            gateway_ipv4_address string
                          Адрес шлюза IPv4. Максимальная длина строки в символах — 15.
                          service_account_id string
                          Сервисный аккаунт, используемый для выделения Compute Cloud и VPC ресурсов для кластера Kubernetes.
                          node_service_account_id string
                          Сервисный аккаунт, используемый узлами кластера Kubernetes для доступа к Container Registry или для загрузки логов и метрик узла.
                          release_channel enum ReleaseChannel
                          При создании кластера Kubernetes вы должны указать один из трех релизных каналов. Релизный канал содержит несколько версий Kubernetes. Каналы отличаются набором доступных версий, управлением автоматическими обновлениями и получаемыми обновлениями. Изменить канал после создания кластера Kubernetes нельзя, возможно только пересоздать кластер Kubernetes и указать новый релизный канал. Дополнительные сведения см. в documentation.
                          • RAPID: На канале часто появляются минорные обновления, содержащие новую функциональность и улучшения. Вы не можете отключить автоматическое обновление на этом канале, но вы можете указать период времени для автоматического обновления.
                          • REGULAR: Новая функциональность и улучшения порциями попадают на канал через некоторое время после того, как были предоставлены на канале RAPID.
                          • STABLE: На канале происходят только обновления, касающиеся исправление ошибок или улучшения безопасности.
                            network_policy NetworkPolicy

                            Master

                            Поле Описание
                            master_type oneof: zonal_master или regional_master
                              zonal_master ZonalMaster
                            Параметры зоны доступности мастера.
                              regional_master RegionalMaster
                            Параметры региона для мастера.
                            version string
                            Версия компонентов Kubernetes, которая запущена на мастере.
                            endpoints MasterEndpoints
                            Эндпойнт мастера. Эндпойнты состоят из схемы и порта (т. е. https://ip-address:port) и могут использоваться клиентами для связи с API Kubernetes кластера Kubernetes.
                            master_auth MasterAuth
                            Параметры, используемые для аутентификации мастера.
                            version_info VersionInfo
                            Подробная информация о версии Kubernetes, которая запущена на мастере.
                            maintenance_policy MasterMaintenancePolicy
                            Политика обновления мастера.

                            ZonalMaster

                            Поле Описание
                            zone_id string
                            Идентификатор зоны доступности, в которой находится мастер.
                            internal_v4_address string
                            Внутренний IPv4-адрес, назначенный мастеру.
                            external_v4_address string
                            Внешний IPv4-адрес, назначенный мастеру.

                            RegionalMaster

                            Поле Описание
                            region_id string
                            Идентификатор региона, в котором находится мастер.
                            internal_v4_address string
                            Внутренний IPv4-адрес, назначенный мастеру.
                            external_v4_address string
                            Внешний IPv4-адрес, назначенный мастеру.

                            MasterEndpoints

                            Поле Описание
                            internal_v4_endpoint string
                            Внутренний эндпойнт, который может использоваться для подключения к мастеру из облачных сетей.
                            external_v4_endpoint string
                            Внешний эндпойнт, который может использоваться для доступа к API кластера Kubernetes из интернета (вне Облака).

                            MasterAuth

                            Поле Описание
                            cluster_ca_certificate string
                            Публичный PEM-закодированный сертификат, подтверждающий подлинность кластера Kubernetes.

                            VersionInfo

                            Поле Описание
                            current_version string
                            Текущая версия Kubernetes, формат: major.minor (например, 1.15).
                            new_revision_available bool
                            Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах.
                            new_revision_summary string
                            Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false.
                            version_deprecated bool
                            Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен.

                            MasterMaintenancePolicy

                            Поле Описание
                            auto_upgrade bool
                            Если установлено значение true, автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false, автоматическое обновление отключено.
                            maintenance_window MaintenanceWindow
                            Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.

                            MaintenanceWindow

                            Поле Описание
                            policy oneof: anytime, daily_maintenance_window или weekly_maintenance_window
                            Политика обновления.
                              anytime AnytimeMaintenanceWindow
                            Обновление мастера в любое время.
                              daily_maintenance_window DailyMaintenanceWindow
                            Обновление мастера в любой день в течение указанного временного окна.
                              weekly_maintenance_window WeeklyMaintenanceWindow
                            Обновление мастера в выбранные дни в течение указанного временного окна.

                            AnytimeMaintenanceWindow

                            DailyMaintenanceWindow

                            Поле Описание
                            start_time google.type.TimeOfDay
                            Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                            duration google.protobuf.Duration
                            Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                            WeeklyMaintenanceWindow

                            Поле Описание
                            days_of_week[] DaysOfWeekMaintenanceWindow
                            Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.

                            DaysOfWeekMaintenanceWindow

                            Поле Описание
                            days[] google.type.DayOfWeek
                            Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.
                            start_time google.type.TimeOfDay
                            Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                            duration google.protobuf.Duration
                            Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                            IPAllocationPolicy

                            Поле Описание
                            cluster_ipv4_cidr_block string
                            CIDR. Диапазон IP-адресов для подов.
                            Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes. Статические маршруты будут настроены для этих блоков CIDR в подсетях узлов.
                            service_ipv4_cidr_block string
                            CIDR. Диапазон IP-адресов для сервисов.
                            Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes.

                            NetworkPolicy

                            Поле Описание
                            provider enum Provider

                              Update

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

                              rpc Update (UpdateClusterRequest) returns (operation.Operation)

                              Метаданные и результат операции:

                                  Operation.metadata:UpdateClusterMetadata

                                  Operation.response:Cluster

                              UpdateClusterRequest

                              Поле Описание
                              cluster_id string
                              Обязательное поле. Идентификатор обновляемого кластера Kubernetes. Чтобы получить идентификатор кластера Kubernetes, используйте ClusterService.List запрос.
                              update_mask google.protobuf.FieldMask
                              name string
                              Имя кластера Kubernetes. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
                              description string
                              Описание кластера Kubernetes. Максимальная длина строки в символах — 256.
                              labels map<string,string>
                              Метки ресурса в формате key:value.
                              Существующий набор labels полностью перезаписывается набором, переданным в запросе. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
                              internet_gateway oneof: gateway_ipv4_address
                                gateway_ipv4_address string
                              Адрес шлюза IPv4. Максимальная длина строки в символах — 15.
                              master_spec MasterUpdateSpec
                              Спецификация обновления мастера.
                              service_account_id string
                              Сервисный аккаунт, используемый для выделения Compute Cloud и VPC ресурсов для кластера Kubernetes. Выбранный сервисный аккаунт должна иметь edit роль в каталоге, в котором будет расположен кластер Kubernetes, и в каталоге, в котором находится выбранная сеть.
                              node_service_account_id string
                              Сервисный аккаунт, используемый узлами кластера Kubernetes для доступа к Container Registry или для загрузки логов и метрик узла.
                              network_policy NetworkPolicy

                              MasterUpdateSpec

                              Поле Описание
                              version UpdateVersionSpec
                              Спецификация обновления мастера.
                              maintenance_policy MasterMaintenancePolicy
                              Политика обновления мастера.

                              UpdateVersionSpec

                              Поле Описание
                              specifier oneof: version или latest_revision
                                version string
                              Запрос обновления до более новой версии Kubernetes (1.x - > 1.y).
                                latest_revision bool
                              Запрос минорного обновления, содержащего новую функциональность и улучшения, для текущей версии Kubernetes.

                              MasterMaintenancePolicy

                              Поле Описание
                              auto_upgrade bool
                              Если установлено значение true, автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false, автоматическое обновление отключено.
                              maintenance_window MaintenanceWindow
                              Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.

                              MaintenanceWindow

                              Поле Описание
                              policy oneof: anytime, daily_maintenance_window или weekly_maintenance_window
                              Политика обновления.
                                anytime AnytimeMaintenanceWindow
                              Обновление мастера в любое время.
                                daily_maintenance_window DailyMaintenanceWindow
                              Обновление мастера в любой день в течение указанного временного окна.
                                weekly_maintenance_window WeeklyMaintenanceWindow
                              Обновление мастера в выбранные дни в течение указанного временного окна.

                              AnytimeMaintenanceWindow

                              DailyMaintenanceWindow

                              Поле Описание
                              start_time google.type.TimeOfDay
                              Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                              duration google.protobuf.Duration
                              Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                              WeeklyMaintenanceWindow

                              Поле Описание
                              days_of_week[] DaysOfWeekMaintenanceWindow
                              Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.

                              DaysOfWeekMaintenanceWindow

                              Поле Описание
                              days[] google.type.DayOfWeek
                              Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.
                              start_time google.type.TimeOfDay
                              Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                              duration google.protobuf.Duration
                              Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                              NetworkPolicy

                              Поле Описание
                              provider enum Provider

                                Operation

                                Поле Описание
                                id string
                                Идентификатор операции.
                                description string
                                Описание операции. Длина описания должна быть от 0 до 256 символов.
                                created_at google.protobuf.Timestamp
                                Время создания ресурса в формате в RFC3339.
                                created_by string
                                Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                modified_at google.protobuf.Timestamp
                                Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                done bool
                                Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                metadata google.protobuf.Any<UpdateClusterMetadata>
                                Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                result oneof: error или response
                                Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                  error google.rpc.Status
                                Описание ошибки в случае сбоя или отмены операции.
                                  response google.protobuf.Any<Cluster>
                                в случае успешного выполнения операции.

                                UpdateClusterMetadata

                                Поле Описание
                                cluster_id string
                                Идентификатор кластера Kubernetes, который обновляется.

                                Cluster

                                Поле Описание
                                id string
                                Идентификатор кластера Kubernetes.
                                folder_id string
                                Идентификатор каталога, которому принадлежит кластер Kubernetes.
                                created_at google.protobuf.Timestamp
                                Время создания.
                                name string
                                Имя кластера Kubernetes.
                                description string
                                Описание кластера Kubernetes. Длина описания должна быть от 0 до 256 символов.
                                labels map<string,string>
                                Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
                                status enum Status
                                Статус кластера Kubernetes.
                                • PROVISIONING: Кластер Kubernetes ожидает выделения ресурсов.
                                • RUNNING: Кластер Kubernetes запущен.
                                • RECONCILING: Кластер Kubernetes согласовывается.
                                • STOPPING: Кластер Kubernetes останавливается.
                                • STOPPED: Кластер Kubernetes остановлен.
                                • DELETING: Кластер Kubernetes удаляется.
                                • STARTING: Кластер Kubernetes запускается.
                                  health enum Health
                                  Состояние кластера Kubernetes.
                                  • HEALTHY: Кластер Kubernetes работает нормально.
                                  • UNHEALTHY: Кластер Kubernetes не работает и не может выполнять свои основные функции.
                                    network_id string
                                    Идентификатор облачной сети, к которой принадлежит кластер Kubernetes.
                                    master Master
                                    Свойства мастера для кластера Kubernetes.
                                    ip_allocation_policy IPAllocationPolicy
                                    Политика распределения IP-адресов для служб и модулей внутри кластера Kubernetes в разных зонах доступности.
                                    internet_gateway oneof: gateway_ipv4_address
                                      gateway_ipv4_address string
                                    Адрес шлюза IPv4. Максимальная длина строки в символах — 15.
                                    service_account_id string
                                    Сервисный аккаунт, используемый для выделения Compute Cloud и VPC ресурсов для кластера Kubernetes.
                                    node_service_account_id string
                                    Сервисный аккаунт, используемый узлами кластера Kubernetes для доступа к Container Registry или для загрузки логов и метрик узла.
                                    release_channel enum ReleaseChannel
                                    При создании кластера Kubernetes вы должны указать один из трех релизных каналов. Релизный канал содержит несколько версий Kubernetes. Каналы отличаются набором доступных версий, управлением автоматическими обновлениями и получаемыми обновлениями. Изменить канал после создания кластера Kubernetes нельзя, возможно только пересоздать кластер Kubernetes и указать новый релизный канал. Дополнительные сведения см. в documentation.
                                    • RAPID: На канале часто появляются минорные обновления, содержащие новую функциональность и улучшения. Вы не можете отключить автоматическое обновление на этом канале, но вы можете указать период времени для автоматического обновления.
                                    • REGULAR: Новая функциональность и улучшения порциями попадают на канал через некоторое время после того, как были предоставлены на канале RAPID.
                                    • STABLE: На канале происходят только обновления, касающиеся исправление ошибок или улучшения безопасности.
                                      network_policy NetworkPolicy

                                      Master

                                      Поле Описание
                                      master_type oneof: zonal_master или regional_master
                                        zonal_master ZonalMaster
                                      Параметры зоны доступности мастера.
                                        regional_master RegionalMaster
                                      Параметры региона для мастера.
                                      version string
                                      Версия компонентов Kubernetes, которая запущена на мастере.
                                      endpoints MasterEndpoints
                                      Эндпойнт мастера. Эндпойнты состоят из схемы и порта (т. е. https://ip-address:port) и могут использоваться клиентами для связи с API Kubernetes кластера Kubernetes.
                                      master_auth MasterAuth
                                      Параметры, используемые для аутентификации мастера.
                                      version_info VersionInfo
                                      Подробная информация о версии Kubernetes, которая запущена на мастере.
                                      maintenance_policy MasterMaintenancePolicy
                                      Политика обновления мастера.

                                      ZonalMaster

                                      Поле Описание
                                      zone_id string
                                      Идентификатор зоны доступности, в которой находится мастер.
                                      internal_v4_address string
                                      Внутренний IPv4-адрес, назначенный мастеру.
                                      external_v4_address string
                                      Внешний IPv4-адрес, назначенный мастеру.

                                      RegionalMaster

                                      Поле Описание
                                      region_id string
                                      Идентификатор региона, в котором находится мастер.
                                      internal_v4_address string
                                      Внутренний IPv4-адрес, назначенный мастеру.
                                      external_v4_address string
                                      Внешний IPv4-адрес, назначенный мастеру.

                                      MasterEndpoints

                                      Поле Описание
                                      internal_v4_endpoint string
                                      Внутренний эндпойнт, который может использоваться для подключения к мастеру из облачных сетей.
                                      external_v4_endpoint string
                                      Внешний эндпойнт, который может использоваться для доступа к API кластера Kubernetes из интернета (вне Облака).

                                      MasterAuth

                                      Поле Описание
                                      cluster_ca_certificate string
                                      Публичный PEM-закодированный сертификат, подтверждающий подлинность кластера Kubernetes.

                                      VersionInfo

                                      Поле Описание
                                      current_version string
                                      Текущая версия Kubernetes, формат: major.minor (например, 1.15).
                                      new_revision_available bool
                                      Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах.
                                      new_revision_summary string
                                      Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false.
                                      version_deprecated bool
                                      Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен.

                                      MasterMaintenancePolicy

                                      Поле Описание
                                      auto_upgrade bool
                                      Если установлено значение true, автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false, автоматическое обновление отключено.
                                      maintenance_window MaintenanceWindow
                                      Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.

                                      MaintenanceWindow

                                      Поле Описание
                                      policy oneof: anytime, daily_maintenance_window или weekly_maintenance_window
                                      Политика обновления.
                                        anytime AnytimeMaintenanceWindow
                                      Обновление мастера в любое время.
                                        daily_maintenance_window DailyMaintenanceWindow
                                      Обновление мастера в любой день в течение указанного временного окна.
                                        weekly_maintenance_window WeeklyMaintenanceWindow
                                      Обновление мастера в выбранные дни в течение указанного временного окна.

                                      AnytimeMaintenanceWindow

                                      DailyMaintenanceWindow

                                      Поле Описание
                                      start_time google.type.TimeOfDay
                                      Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                                      duration google.protobuf.Duration
                                      Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                                      WeeklyMaintenanceWindow

                                      Поле Описание
                                      days_of_week[] DaysOfWeekMaintenanceWindow
                                      Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.

                                      DaysOfWeekMaintenanceWindow

                                      Поле Описание
                                      days[] google.type.DayOfWeek
                                      Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.
                                      start_time google.type.TimeOfDay
                                      Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                                      duration google.protobuf.Duration
                                      Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                                      IPAllocationPolicy

                                      Поле Описание
                                      cluster_ipv4_cidr_block string
                                      CIDR. Диапазон IP-адресов для подов.
                                      Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes. Статические маршруты будут настроены для этих блоков CIDR в подсетях узлов.
                                      service_ipv4_cidr_block string
                                      CIDR. Диапазон IP-адресов для сервисов.
                                      Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes.

                                      NetworkPolicy

                                      Поле Описание
                                      provider enum Provider

                                        Delete

                                        Удаляет указанный кластер Kubernetes.

                                        rpc Delete (DeleteClusterRequest) returns (operation.Operation)

                                        Метаданные и результат операции:

                                            Operation.metadata:DeleteClusterMetadata

                                            Operation.response:google.protobuf.Empty

                                        DeleteClusterRequest

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

                                        Operation

                                        Поле Описание
                                        id string
                                        Идентификатор операции.
                                        description string
                                        Описание операции. Длина описания должна быть от 0 до 256 символов.
                                        created_at google.protobuf.Timestamp
                                        Время создания ресурса в формате в RFC3339.
                                        created_by string
                                        Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                        modified_at google.protobuf.Timestamp
                                        Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                        done bool
                                        Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                        metadata google.protobuf.Any<DeleteClusterMetadata>
                                        Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                        result oneof: error или response
                                        Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                          error google.rpc.Status
                                        Описание ошибки в случае сбоя или отмены операции.
                                          response google.protobuf.Any<google.protobuf.Empty>
                                        в случае успешного выполнения операции.

                                        DeleteClusterMetadata

                                        Поле Описание
                                        cluster_id string
                                        Идентификатор кластера Kubernetes, который удаляется.

                                        Stop

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

                                        rpc Stop (StopClusterRequest) returns (operation.Operation)

                                        Метаданные и результат операции:

                                            Operation.metadata:StopClusterMetadata

                                            Operation.response:Cluster

                                        StopClusterRequest

                                        Поле Описание
                                        cluster_id string
                                        Обязательное поле. Идентификатор кластера Kubernetes, который следует остановить. Чтобы получить идентификатор кластера Kubernetes, используйте запрос ClusterService.List.
                                        service_account_id string
                                        Идентификатор сервисного аккаунта с ролью на остановку кластера Kubernetes.

                                        Operation

                                        Поле Описание
                                        id string
                                        Идентификатор операции.
                                        description string
                                        Описание операции. Длина описания должна быть от 0 до 256 символов.
                                        created_at google.protobuf.Timestamp
                                        Время создания ресурса в формате в RFC3339.
                                        created_by string
                                        Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                        modified_at google.protobuf.Timestamp
                                        Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                        done bool
                                        Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                        metadata google.protobuf.Any<StopClusterMetadata>
                                        Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                        result oneof: error или response
                                        Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                          error google.rpc.Status
                                        Описание ошибки в случае сбоя или отмены операции.
                                          response google.protobuf.Any<Cluster>
                                        в случае успешного выполнения операции.

                                        StopClusterMetadata

                                        Поле Описание
                                        cluster_id string
                                        Идентификатор кластера Kubernetes, который останавливается.

                                        Cluster

                                        Поле Описание
                                        id string
                                        Идентификатор кластера Kubernetes.
                                        folder_id string
                                        Идентификатор каталога, которому принадлежит кластер Kubernetes.
                                        created_at google.protobuf.Timestamp
                                        Время создания.
                                        name string
                                        Имя кластера Kubernetes.
                                        description string
                                        Описание кластера Kubernetes. Длина описания должна быть от 0 до 256 символов.
                                        labels map<string,string>
                                        Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
                                        status enum Status
                                        Статус кластера Kubernetes.
                                        • PROVISIONING: Кластер Kubernetes ожидает выделения ресурсов.
                                        • RUNNING: Кластер Kubernetes запущен.
                                        • RECONCILING: Кластер Kubernetes согласовывается.
                                        • STOPPING: Кластер Kubernetes останавливается.
                                        • STOPPED: Кластер Kubernetes остановлен.
                                        • DELETING: Кластер Kubernetes удаляется.
                                        • STARTING: Кластер Kubernetes запускается.
                                          health enum Health
                                          Состояние кластера Kubernetes.
                                          • HEALTHY: Кластер Kubernetes работает нормально.
                                          • UNHEALTHY: Кластер Kubernetes не работает и не может выполнять свои основные функции.
                                            network_id string
                                            Идентификатор облачной сети, к которой принадлежит кластер Kubernetes.
                                            master Master
                                            Свойства мастера для кластера Kubernetes.
                                            ip_allocation_policy IPAllocationPolicy
                                            Политика распределения IP-адресов для служб и модулей внутри кластера Kubernetes в разных зонах доступности.
                                            internet_gateway oneof: gateway_ipv4_address
                                              gateway_ipv4_address string
                                            Адрес шлюза IPv4. Максимальная длина строки в символах — 15.
                                            service_account_id string
                                            Сервисный аккаунт, используемый для выделения Compute Cloud и VPC ресурсов для кластера Kubernetes.
                                            node_service_account_id string
                                            Сервисный аккаунт, используемый узлами кластера Kubernetes для доступа к Container Registry или для загрузки логов и метрик узла.
                                            release_channel enum ReleaseChannel
                                            При создании кластера Kubernetes вы должны указать один из трех релизных каналов. Релизный канал содержит несколько версий Kubernetes. Каналы отличаются набором доступных версий, управлением автоматическими обновлениями и получаемыми обновлениями. Изменить канал после создания кластера Kubernetes нельзя, возможно только пересоздать кластер Kubernetes и указать новый релизный канал. Дополнительные сведения см. в documentation.
                                            • RAPID: На канале часто появляются минорные обновления, содержащие новую функциональность и улучшения. Вы не можете отключить автоматическое обновление на этом канале, но вы можете указать период времени для автоматического обновления.
                                            • REGULAR: Новая функциональность и улучшения порциями попадают на канал через некоторое время после того, как были предоставлены на канале RAPID.
                                            • STABLE: На канале происходят только обновления, касающиеся исправление ошибок или улучшения безопасности.
                                              network_policy NetworkPolicy

                                              Master

                                              Поле Описание
                                              master_type oneof: zonal_master или regional_master
                                                zonal_master ZonalMaster
                                              Параметры зоны доступности мастера.
                                                regional_master RegionalMaster
                                              Параметры региона для мастера.
                                              version string
                                              Версия компонентов Kubernetes, которая запущена на мастере.
                                              endpoints MasterEndpoints
                                              Эндпойнт мастера. Эндпойнты состоят из схемы и порта (т. е. https://ip-address:port) и могут использоваться клиентами для связи с API Kubernetes кластера Kubernetes.
                                              master_auth MasterAuth
                                              Параметры, используемые для аутентификации мастера.
                                              version_info VersionInfo
                                              Подробная информация о версии Kubernetes, которая запущена на мастере.
                                              maintenance_policy MasterMaintenancePolicy
                                              Политика обновления мастера.

                                              ZonalMaster

                                              Поле Описание
                                              zone_id string
                                              Идентификатор зоны доступности, в которой находится мастер.
                                              internal_v4_address string
                                              Внутренний IPv4-адрес, назначенный мастеру.
                                              external_v4_address string
                                              Внешний IPv4-адрес, назначенный мастеру.

                                              RegionalMaster

                                              Поле Описание
                                              region_id string
                                              Идентификатор региона, в котором находится мастер.
                                              internal_v4_address string
                                              Внутренний IPv4-адрес, назначенный мастеру.
                                              external_v4_address string
                                              Внешний IPv4-адрес, назначенный мастеру.

                                              MasterEndpoints

                                              Поле Описание
                                              internal_v4_endpoint string
                                              Внутренний эндпойнт, который может использоваться для подключения к мастеру из облачных сетей.
                                              external_v4_endpoint string
                                              Внешний эндпойнт, который может использоваться для доступа к API кластера Kubernetes из интернета (вне Облака).

                                              MasterAuth

                                              Поле Описание
                                              cluster_ca_certificate string
                                              Публичный PEM-закодированный сертификат, подтверждающий подлинность кластера Kubernetes.

                                              VersionInfo

                                              Поле Описание
                                              current_version string
                                              Текущая версия Kubernetes, формат: major.minor (например, 1.15).
                                              new_revision_available bool
                                              Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах.
                                              new_revision_summary string
                                              Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false.
                                              version_deprecated bool
                                              Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен.

                                              MasterMaintenancePolicy

                                              Поле Описание
                                              auto_upgrade bool
                                              Если установлено значение true, автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false, автоматическое обновление отключено.
                                              maintenance_window MaintenanceWindow
                                              Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.

                                              MaintenanceWindow

                                              Поле Описание
                                              policy oneof: anytime, daily_maintenance_window или weekly_maintenance_window
                                              Политика обновления.
                                                anytime AnytimeMaintenanceWindow
                                              Обновление мастера в любое время.
                                                daily_maintenance_window DailyMaintenanceWindow
                                              Обновление мастера в любой день в течение указанного временного окна.
                                                weekly_maintenance_window WeeklyMaintenanceWindow
                                              Обновление мастера в выбранные дни в течение указанного временного окна.

                                              AnytimeMaintenanceWindow

                                              DailyMaintenanceWindow

                                              Поле Описание
                                              start_time google.type.TimeOfDay
                                              Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                                              duration google.protobuf.Duration
                                              Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                                              WeeklyMaintenanceWindow

                                              Поле Описание
                                              days_of_week[] DaysOfWeekMaintenanceWindow
                                              Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.

                                              DaysOfWeekMaintenanceWindow

                                              Поле Описание
                                              days[] google.type.DayOfWeek
                                              Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.
                                              start_time google.type.TimeOfDay
                                              Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                                              duration google.protobuf.Duration
                                              Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                                              IPAllocationPolicy

                                              Поле Описание
                                              cluster_ipv4_cidr_block string
                                              CIDR. Диапазон IP-адресов для подов.
                                              Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes. Статические маршруты будут настроены для этих блоков CIDR в подсетях узлов.
                                              service_ipv4_cidr_block string
                                              CIDR. Диапазон IP-адресов для сервисов.
                                              Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes.

                                              NetworkPolicy

                                              Поле Описание
                                              provider enum Provider

                                                Start

                                                Запускает указанный кластер Kubernetes.

                                                rpc Start (StartClusterRequest) returns (operation.Operation)

                                                Метаданные и результат операции:

                                                    Operation.metadata:StartClusterMetadata

                                                    Operation.response:Cluster

                                                StartClusterRequest

                                                Поле Описание
                                                cluster_id string
                                                Обязательное поле. Идентификатор кластера Kubernetes, который следует запустить. Чтобы получить идентификатор кластера Kubernetes, используйте запрос ClusterService.List.

                                                Operation

                                                Поле Описание
                                                id string
                                                Идентификатор операции.
                                                description string
                                                Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                created_at google.protobuf.Timestamp
                                                Время создания ресурса в формате в RFC3339.
                                                created_by string
                                                Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                modified_at google.protobuf.Timestamp
                                                Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                done bool
                                                Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                metadata google.protobuf.Any<StartClusterMetadata>
                                                Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                result oneof: error или response
                                                Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                  error google.rpc.Status
                                                Описание ошибки в случае сбоя или отмены операции.
                                                  response google.protobuf.Any<Cluster>
                                                в случае успешного выполнения операции.

                                                StartClusterMetadata

                                                Поле Описание
                                                cluster_id string
                                                Идентификатор кластера Kubernetes, который запускается.

                                                Cluster

                                                Поле Описание
                                                id string
                                                Идентификатор кластера Kubernetes.
                                                folder_id string
                                                Идентификатор каталога, которому принадлежит кластер Kubernetes.
                                                created_at google.protobuf.Timestamp
                                                Время создания.
                                                name string
                                                Имя кластера Kubernetes.
                                                description string
                                                Описание кластера Kubernetes. Длина описания должна быть от 0 до 256 символов.
                                                labels map<string,string>
                                                Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
                                                status enum Status
                                                Статус кластера Kubernetes.
                                                • PROVISIONING: Кластер Kubernetes ожидает выделения ресурсов.
                                                • RUNNING: Кластер Kubernetes запущен.
                                                • RECONCILING: Кластер Kubernetes согласовывается.
                                                • STOPPING: Кластер Kubernetes останавливается.
                                                • STOPPED: Кластер Kubernetes остановлен.
                                                • DELETING: Кластер Kubernetes удаляется.
                                                • STARTING: Кластер Kubernetes запускается.
                                                  health enum Health
                                                  Состояние кластера Kubernetes.
                                                  • HEALTHY: Кластер Kubernetes работает нормально.
                                                  • UNHEALTHY: Кластер Kubernetes не работает и не может выполнять свои основные функции.
                                                    network_id string
                                                    Идентификатор облачной сети, к которой принадлежит кластер Kubernetes.
                                                    master Master
                                                    Свойства мастера для кластера Kubernetes.
                                                    ip_allocation_policy IPAllocationPolicy
                                                    Политика распределения IP-адресов для служб и модулей внутри кластера Kubernetes в разных зонах доступности.
                                                    internet_gateway oneof: gateway_ipv4_address
                                                      gateway_ipv4_address string
                                                    Адрес шлюза IPv4. Максимальная длина строки в символах — 15.
                                                    service_account_id string
                                                    Сервисный аккаунт, используемый для выделения Compute Cloud и VPC ресурсов для кластера Kubernetes.
                                                    node_service_account_id string
                                                    Сервисный аккаунт, используемый узлами кластера Kubernetes для доступа к Container Registry или для загрузки логов и метрик узла.
                                                    release_channel enum ReleaseChannel
                                                    При создании кластера Kubernetes вы должны указать один из трех релизных каналов. Релизный канал содержит несколько версий Kubernetes. Каналы отличаются набором доступных версий, управлением автоматическими обновлениями и получаемыми обновлениями. Изменить канал после создания кластера Kubernetes нельзя, возможно только пересоздать кластер Kubernetes и указать новый релизный канал. Дополнительные сведения см. в documentation.
                                                    • RAPID: На канале часто появляются минорные обновления, содержащие новую функциональность и улучшения. Вы не можете отключить автоматическое обновление на этом канале, но вы можете указать период времени для автоматического обновления.
                                                    • REGULAR: Новая функциональность и улучшения порциями попадают на канал через некоторое время после того, как были предоставлены на канале RAPID.
                                                    • STABLE: На канале происходят только обновления, касающиеся исправление ошибок или улучшения безопасности.
                                                      network_policy NetworkPolicy

                                                      Master

                                                      Поле Описание
                                                      master_type oneof: zonal_master или regional_master
                                                        zonal_master ZonalMaster
                                                      Параметры зоны доступности мастера.
                                                        regional_master RegionalMaster
                                                      Параметры региона для мастера.
                                                      version string
                                                      Версия компонентов Kubernetes, которая запущена на мастере.
                                                      endpoints MasterEndpoints
                                                      Эндпойнт мастера. Эндпойнты состоят из схемы и порта (т. е. https://ip-address:port) и могут использоваться клиентами для связи с API Kubernetes кластера Kubernetes.
                                                      master_auth MasterAuth
                                                      Параметры, используемые для аутентификации мастера.
                                                      version_info VersionInfo
                                                      Подробная информация о версии Kubernetes, которая запущена на мастере.
                                                      maintenance_policy MasterMaintenancePolicy
                                                      Политика обновления мастера.

                                                      ZonalMaster

                                                      Поле Описание
                                                      zone_id string
                                                      Идентификатор зоны доступности, в которой находится мастер.
                                                      internal_v4_address string
                                                      Внутренний IPv4-адрес, назначенный мастеру.
                                                      external_v4_address string
                                                      Внешний IPv4-адрес, назначенный мастеру.

                                                      RegionalMaster

                                                      Поле Описание
                                                      region_id string
                                                      Идентификатор региона, в котором находится мастер.
                                                      internal_v4_address string
                                                      Внутренний IPv4-адрес, назначенный мастеру.
                                                      external_v4_address string
                                                      Внешний IPv4-адрес, назначенный мастеру.

                                                      MasterEndpoints

                                                      Поле Описание
                                                      internal_v4_endpoint string
                                                      Внутренний эндпойнт, который может использоваться для подключения к мастеру из облачных сетей.
                                                      external_v4_endpoint string
                                                      Внешний эндпойнт, который может использоваться для доступа к API кластера Kubernetes из интернета (вне Облака).

                                                      MasterAuth

                                                      Поле Описание
                                                      cluster_ca_certificate string
                                                      Публичный PEM-закодированный сертификат, подтверждающий подлинность кластера Kubernetes.

                                                      VersionInfo

                                                      Поле Описание
                                                      current_version string
                                                      Текущая версия Kubernetes, формат: major.minor (например, 1.15).
                                                      new_revision_available bool
                                                      Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах.
                                                      new_revision_summary string
                                                      Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false.
                                                      version_deprecated bool
                                                      Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен.

                                                      MasterMaintenancePolicy

                                                      Поле Описание
                                                      auto_upgrade bool
                                                      Если установлено значение true, автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false, автоматическое обновление отключено.
                                                      maintenance_window MaintenanceWindow
                                                      Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.

                                                      MaintenanceWindow

                                                      Поле Описание
                                                      policy oneof: anytime, daily_maintenance_window или weekly_maintenance_window
                                                      Политика обновления.
                                                        anytime AnytimeMaintenanceWindow
                                                      Обновление мастера в любое время.
                                                        daily_maintenance_window DailyMaintenanceWindow
                                                      Обновление мастера в любой день в течение указанного временного окна.
                                                        weekly_maintenance_window WeeklyMaintenanceWindow
                                                      Обновление мастера в выбранные дни в течение указанного временного окна.

                                                      AnytimeMaintenanceWindow

                                                      DailyMaintenanceWindow

                                                      Поле Описание
                                                      start_time google.type.TimeOfDay
                                                      Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                                                      duration google.protobuf.Duration
                                                      Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                                                      WeeklyMaintenanceWindow

                                                      Поле Описание
                                                      days_of_week[] DaysOfWeekMaintenanceWindow
                                                      Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.

                                                      DaysOfWeekMaintenanceWindow

                                                      Поле Описание
                                                      days[] google.type.DayOfWeek
                                                      Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.
                                                      start_time google.type.TimeOfDay
                                                      Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                                                      duration google.protobuf.Duration
                                                      Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                                                      IPAllocationPolicy

                                                      Поле Описание
                                                      cluster_ipv4_cidr_block string
                                                      CIDR. Диапазон IP-адресов для подов.
                                                      Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes. Статические маршруты будут настроены для этих блоков CIDR в подсетях узлов.
                                                      service_ipv4_cidr_block string
                                                      CIDR. Диапазон IP-адресов для сервисов.
                                                      Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes.

                                                      NetworkPolicy

                                                      Поле Описание
                                                      provider enum Provider

                                                        ListNodeGroups

                                                        Список групп узлов для указанного кластера Kubernetes.

                                                        rpc ListNodeGroups (ListClusterNodeGroupsRequest) returns (ListClusterNodeGroupsResponse)

                                                        ListClusterNodeGroupsRequest

                                                        Поле Описание
                                                        cluster_id string
                                                        Обязательное поле. Идентификатор кластера Kubernetes, для которого запрашивается список групп узлов. Чтобы получить идентификатор кластера Kubernetes, используйтеClusterService.List запрос.
                                                        page_size int64
                                                        Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterNodeGroupsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
                                                        page_token string
                                                        Токен страницы. Установите значение page_token равным значению поля ListClusterNodeGroupsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
                                                        filter string
                                                        Параметры фильтрации ресурсов в ответе. В настоящее время фильтрация осуществляется только по полю Cluster.name. Максимальная длина строки в символах — 1000.

                                                        ListClusterNodeGroupsResponse

                                                        Поле Описание
                                                        node_groups[] NodeGroup
                                                        Список групп узлов для указанного кластера Kubernetes.
                                                        next_page_token string
                                                        Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterNodeGroupsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterNodeGroupsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                        NodeGroup

                                                        Поле Описание
                                                        id string
                                                        Идентификатор группы узлов.
                                                        cluster_id string
                                                        Идентификатор кластера, к которому принадлежит группа узлов.
                                                        created_at google.protobuf.Timestamp
                                                        Время создания.
                                                        name string
                                                        Новое имя группы узлов. Имя уникально в рамках каталога.
                                                        description string
                                                        Новое описание группы узлов. Длина описания должна быть от 0 до 256 символов.
                                                        labels map<string,string>
                                                        Метки ресурса в формате key:value. Максимум 64 метки на ресурс.
                                                        status enum Status
                                                        Статус группы узлов.
                                                        • PROVISIONING: Группа узлов ожидает выделения ресурсов.
                                                        • RUNNING: Группа узлов запущена.
                                                        • RECONCILING: Группа узлов ожидает выполнения некоторых работ, например, обновления программного обеспечения узла.
                                                        • STOPPING: Группа узлов останавливается.
                                                        • STOPPED: Группа узлов остановлена.
                                                        • DELETING: Группа узлов удаляется.
                                                        • STARTING: Группа узлов запускается.
                                                          node_template NodeTemplate
                                                          Шаблон узла, задающий параметры вычислительных экземпляров для группы узлов.
                                                          scale_policy ScalePolicy
                                                          Политика масштабирования группы узлов. Дополнительные сведения см. в разделе Scaling policy.
                                                          allocation_policy NodeGroupAllocationPolicy
                                                          Политика распределения, с помощью которой ресурсы для групп узлов распределяются по зонам и регионам.
                                                          instance_group_id string
                                                          Идентификатор группы виртуальных машин, связанной с этой группой узлов.
                                                          node_version string
                                                          Версия компонентов Kubernetes, которая запущена на узлах. Устарел. Используйте version_info.current_version.
                                                          version_info VersionInfo
                                                          Подробная информация о версии Kubernetes, которая запущена на мастере.
                                                          maintenance_policy NodeGroupMaintenancePolicy
                                                          Политика обновления группы узлов.
                                                          allowed_unsafe_sysctls[] string
                                                          Поддержка параметров unsafe sysctl. Дополнительные сведения см. в documentation.

                                                          NodeTemplate

                                                          Поле Описание
                                                          platform_id string
                                                          Идентификатор аппаратной платформы виртуальной машины.
                                                          resources_spec ResourcesSpec
                                                          Вычислительные ресурсы узла, такие как объем памяти и количество ядер.
                                                          boot_disk_spec DiskSpec
                                                          Спецификация загрузочного диска, который будет подключен к узлу.
                                                          metadata map<string,string>
                                                          Метаданные, назначаемые этому шаблону виртуальной машины, в формате key:value. Сюда входят пользовательские метаданные и предопределенные ключи.
                                                          Например, вы можете использовать метаданные для предоставления вашего открытого SSH-ключа узлу. Дополнительные сведения см. в разделе Metadata. Не более 128 на ресурс. Максимальная длина строки в символах для каждого значения — 262144. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
                                                          v4_address_spec NodeAddressSpec
                                                          Спецификация для создания сетевых интерфейсов для вычислительных экземпляров группы узлов.
                                                          scheduling_policy SchedulingPolicy
                                                          Политика планирования.

                                                          ResourcesSpec

                                                          Поле Описание
                                                          memory int64
                                                          Объем памяти в байтах, доступный виртуальной машине. Допустимые значения — от 0 до 274877906944 включительно.
                                                          cores int64
                                                          Количество ядер, доступное узлу. Значение должно быть равно 0,1,2,4,6,8,10,12,14,16,18,20,22,24,26,28,30,32.
                                                          core_fraction int64
                                                          Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0,5,20,50,100.

                                                          DiskSpec

                                                          Поле Описание
                                                          disk_type_id string
                                                          Идентификатор типа диска. Значение должно соответствовать регулярному выражению |network-ssd|network-hdd.
                                                          disk_size int64
                                                          Размер диска в байтах. Допустимые значения — от 0 до 4398046511104 включительно.

                                                          NodeAddressSpec

                                                          Поле Описание
                                                          one_to_one_nat_spec OneToOneNatSpec
                                                          Конфигурация one-to-one NAT. Настройка one-to-one NAT гарантирует, что узлам будут назначены публичные IP-адреса. Поэтому интернет будет доступен на всех узлах группы узлов. Если поле не задано, NAT не будет настроен.

                                                          OneToOneNatSpec

                                                          Поле Описание
                                                          ip_version enum IpVersion
                                                          Версия IP для публичного IP-адреса.
                                                          • IPV4: IPv4-адрес, например 192.168.0.0.
                                                          • IPV6: IPv6-адрес, на данный момент не доступен.

                                                            SchedulingPolicy

                                                            Поле Описание
                                                            preemptible bool
                                                            Если значение равно true — будет создана прерываемая виртуальная машина. Значение по умолчанию: false. Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Preemptible Virtual Machines.

                                                            ScalePolicy

                                                            Поле Описание
                                                            scale_type oneof: fixed_scale или auto_scale
                                                              fixed_scale FixedScale
                                                            Политика масштабирования группы узлов.
                                                              auto_scale AutoScale
                                                            Политика масштабирования группы узлов.

                                                            FixedScale

                                                            Поле Описание
                                                            size int64
                                                            Количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно.

                                                            AutoScale

                                                            Поле Описание
                                                            min_size int64
                                                            Минимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно.
                                                            max_size int64
                                                            Максимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно.
                                                            initial_size int64
                                                            Начальный размер группы узлов. Допустимые значения — от 0 до 100 включительно.

                                                            NodeGroupAllocationPolicy

                                                            Поле Описание
                                                            locations[] NodeGroupLocation
                                                            Список местоположений (зон доступности и подсетей), в которых будут выделены ресурсы для группы узлов.

                                                            NodeGroupLocation

                                                            Поле Описание
                                                            zone_id string
                                                            Обязательное поле. Идентификатор зоны доступности, в которой могут находиться узлы.
                                                            subnet_id string
                                                            Идентификатор подсети. Если сеть, выбранная для кластера Kubernetes, имеет только одну подсеть в указанной зоне, идентификатор подсети может быть опущен.

                                                            VersionInfo

                                                            Поле Описание
                                                            current_version string
                                                            Текущая версия Kubernetes, формат: major.minor (например, 1.15).
                                                            new_revision_available bool
                                                            Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах.
                                                            new_revision_summary string
                                                            Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false.
                                                            version_deprecated bool
                                                            Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен.

                                                            NodeGroupMaintenancePolicy

                                                            Поле Описание
                                                            auto_upgrade bool
                                                            Если установлено значение true, автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение false, автоматическое обновление отключено.
                                                            auto_repair bool
                                                            Если установлено значение true, автоматическое восстановление включено. Значение по умолчанию: false.
                                                            maintenance_window MaintenanceWindow
                                                            Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.

                                                            MaintenanceWindow

                                                            Поле Описание
                                                            policy oneof: anytime, daily_maintenance_window или weekly_maintenance_window
                                                            Политика обновления.
                                                              anytime AnytimeMaintenanceWindow
                                                            Обновление мастера в любое время.
                                                              daily_maintenance_window DailyMaintenanceWindow
                                                            Обновление мастера в любой день в течение указанного временного окна.
                                                              weekly_maintenance_window WeeklyMaintenanceWindow
                                                            Обновление мастера в выбранные дни в течение указанного временного окна.

                                                            AnytimeMaintenanceWindow

                                                            DailyMaintenanceWindow

                                                            Поле Описание
                                                            start_time google.type.TimeOfDay
                                                            Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                                                            duration google.protobuf.Duration
                                                            Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                                                            WeeklyMaintenanceWindow

                                                            Поле Описание
                                                            days_of_week[] DaysOfWeekMaintenanceWindow
                                                            Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.

                                                            DaysOfWeekMaintenanceWindow

                                                            Поле Описание
                                                            days[] google.type.DayOfWeek
                                                            Дни недели, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.
                                                            start_time google.type.TimeOfDay
                                                            Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.
                                                            duration google.protobuf.Duration
                                                            Длительность окна обновлений. Допустимые значения — от 1h до 24h включительно.

                                                            ListOperations

                                                            Список операций для указанного кластера Kubernetes.

                                                            rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)

                                                            ListClusterOperationsRequest

                                                            Поле Описание
                                                            cluster_id string
                                                            Обязательное поле. Идентификатор кластера Kubernetes, для которого запрашивается список операций.
                                                            page_size int64
                                                            Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем page_size, сервис вернет значение ListClusterOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
                                                            page_token string
                                                            Токен страницы. Установите значение page_token равным значению поля ListClusterOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
                                                            filter string
                                                            Параметры фильтрации ресурсов в ответе. В настоящее время фильтрация осуществляется только по полю Cluster.name. Максимальная длина строки в символах — 1000.

                                                            ListClusterOperationsResponse

                                                            Поле Описание
                                                            operations[] operation.Operation
                                                            Список операций для указанного кластера Kubernetes.
                                                            next_page_token string
                                                            Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                            Operation

                                                            Поле Описание
                                                            id string
                                                            Идентификатор операции.
                                                            description string
                                                            Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                            created_at google.protobuf.Timestamp
                                                            Время создания ресурса в формате в RFC3339.
                                                            created_by string
                                                            Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                            modified_at google.protobuf.Timestamp
                                                            Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                            done bool
                                                            Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                            metadata google.protobuf.Any
                                                            Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                            result oneof: error или response
                                                            Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                              error google.rpc.Status
                                                            Описание ошибки в случае сбоя или отмены операции.
                                                              response google.protobuf.Any
                                                            Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.
                                                            В этой статье: