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

Метод get

Возвращает указанную группу узлов.

Чтобы получить список доступных групп узлов, выполните запрос list.

HTTP-запрос

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

Path-параметры

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

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "clusterId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "status": "string",
  "nodeTemplate": {
    "platformId": "string",
    "resourcesSpec": {
      "memory": "string",
      "cores": "string",
      "coreFraction": "string"
    },
    "bootDiskSpec": {
      "diskTypeId": "string",
      "diskSize": "string"
    },
    "metadata": "object",
    "v4AddressSpec": {
      "oneToOneNatSpec": {
        "ipVersion": "string"
      }
    },
    "schedulingPolicy": {
      "preemptible": true
    }
  },
  "scalePolicy": {

    // `scalePolicy` включает только одно из полей `fixedScale`, `autoScale`
    "fixedScale": {
      "size": "string"
    },
    "autoScale": {
      "minSize": "string",
      "maxSize": "string",
      "initialSize": "string"
    },
    // конец списка возможных полей`scalePolicy`

  },
  "allocationPolicy": {
    "locations": [
      {
        "zoneId": "string",
        "subnetId": "string"
      }
    ]
  },
  "instanceGroupId": "string",
  "nodeVersion": "string",
  "versionInfo": {
    "currentVersion": "string",
    "newRevisionAvailable": true,
    "newRevisionSummary": "string",
    "versionDeprecated": true
  },
  "maintenancePolicy": {
    "autoUpgrade": true,
    "autoRepair": true,
    "maintenanceWindow": {

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

    }
  },
  "allowedUnsafeSysctls": [
    "string"
  ]
}
Поле Описание
id string

Идентификатор группы узлов.
clusterId string

Идентификатор кластера, к которому принадлежит группа узлов.
createdAt string (date-time)

Время создания.

Строка в формате RFC3339.
name string

Новое имя группы узлов. Имя уникально в рамках каталога.
description string

Новое описание группы узлов. Длина описания должна быть от 0 до 256 символов.
labels object

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

Статус группы узлов.

  • PROVISIONING: Группа узлов ожидает выделения ресурсов.
  • RUNNING: Группа узлов запущена.
  • RECONCILING: Группа узлов ожидает выполнения некоторых работ, например, обновления программного обеспечения узла.
  • STOPPING: Группа узлов останавливается.
  • STOPPED: Группа узлов остановлена.
  • DELETING: Группа узлов удаляется.
  • STARTING: Группа узлов запускается.
nodeTemplate object

Шаблон узла, задающий параметры вычислительных экземпляров для группы узлов.
nodeTemplate.
platformId		 string

Идентификатор аппаратной платформы виртуальной машины.
nodeTemplate.
resourcesSpec		 object

Вычислительные ресурсы узла, такие как объем памяти и количество ядер.
nodeTemplate.
resourcesSpec.
memory		 string (int64)

Объем памяти в байтах, доступный виртуальной машине.

Допустимые значения — от 0 до 274877906944 включительно.
nodeTemplate.
resourcesSpec.
cores		 string (int64)

Количество ядер, доступное узлу.

Значение должно быть равно 0, 1, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30 или 32.
nodeTemplate.
resourcesSpec.
coreFraction		 string (int64)

Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра.

Значение должно быть равно 0, 5, 20, 50 или 100.
nodeTemplate.
bootDiskSpec		 object

Спецификация загрузочного диска, который будет подключен к узлу.
nodeTemplate.
bootDiskSpec.
diskTypeId		 string

Идентификатор типа диска.

Значение должно соответствовать регулярному выражению |network-ssd|network-hdd.
nodeTemplate.
bootDiskSpec.
diskSize		 string (int64)

Размер диска в байтах.

Допустимые значения — от 0 до 4398046511104 включительно.
nodeTemplate.
metadata		 object

Метаданные, назначаемые этому шаблону виртуальной машины, в формате key:value. Сюда входят пользовательские метаданные и предопределенные ключи.

Например, вы можете использовать метаданные для предоставления вашего открытого SSH-ключа узлу. Дополнительные сведения см. в разделе Metadata.

Не более 128 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*. Максимальная длина строки в символах для каждого значения — 262144.
nodeTemplate.
v4AddressSpec		 object

Спецификация для создания сетевых интерфейсов для вычислительных экземпляров группы узлов.
nodeTemplate.
v4AddressSpec.
oneToOneNatSpec		 object

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

Версия IP для публичного IP-адреса.

  • IPV4: IPv4-адрес, например 192.168.0.0.
  • IPV6: IPv6-адрес, на данный момент не доступен.
nodeTemplate.
schedulingPolicy		 object

Политика планирования.
nodeTemplate.
schedulingPolicy.
preemptible		 boolean (boolean)

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

Политика масштабирования группы узлов. Дополнительные сведения см. в разделе Scaling policy.
scalePolicy.
fixedScale		 object
Политика масштабирования группы узлов.
scalePolicy включает только одно из полей fixedScale, autoScale
scalePolicy.
fixedScale.
size		 string (int64)

Количество узлов в группе узлов.

Допустимые значения — от 0 до 100 включительно.
scalePolicy.
autoScale		 object
Политика масштабирования группы узлов.
scalePolicy включает только одно из полей fixedScale, autoScale
scalePolicy.
autoScale.
minSize		 string (int64)

Минимальное количество узлов в группе узлов.

Допустимые значения — от 0 до 100 включительно.
scalePolicy.
autoScale.
maxSize		 string (int64)

Максимальное количество узлов в группе узлов.

Допустимые значения — от 0 до 100 включительно.
scalePolicy.
autoScale.
initialSize		 string (int64)

Начальный размер группы узлов.

Допустимые значения — от 0 до 100 включительно.
allocationPolicy object

Политика распределения, с помощью которой ресурсы для групп узлов распределяются по зонам и регионам.
allocationPolicy.
locations[]		 object

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

Обязательное поле. Идентификатор зоны доступности, в которой могут находиться узлы.
allocationPolicy.
locations[].
subnetId		 string

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

Идентификатор группы виртуальных машин, связанной с этой группой узлов.
nodeVersion string

Версия компонентов Kubernetes, которая запущена на узлах. Устарел. Используйте version_info.current_version.
versionInfo object

Подробная информация о версии Kubernetes, которая запущена на мастере.
versionInfo.
currentVersion		 string

Текущая версия Kubernetes, формат: major.minor (например, 1.15).
versionInfo.
newRevisionAvailable		 boolean (boolean)

Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах.
versionInfo.
newRevisionSummary		 string

Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false.
versionInfo.
versionDeprecated		 boolean (boolean)

Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен.
maintenancePolicy object

Политика обновления группы узлов.
maintenancePolicy.
autoUpgrade		 boolean (boolean)

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

Если установлено значение true, автоматическое восстановление включено. Значение по умолчанию: false.
maintenancePolicy.
maintenanceWindow		 object

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

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

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
hours		 integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
minutes		 integer (int32)

Minutes of hour of day. Must be from 0 to 59.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
seconds		 integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
nanos		 integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
duration		 string

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

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

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

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

Represents a day of week.

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

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

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
hours		 integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
minutes		 integer (int32)

Minutes of hour of day. Must be from 0 to 59.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
seconds		 integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
nanos		 integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
duration		 string

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

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

Поддержка параметров unsafe sysctl. Дополнительные сведения см. в documentation.