Метод list

HTTP-запрос
Query-параметры
Ответ

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

HTTP-запрос

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

Query-параметры

Параметр	Описание
folderId	Обязательное поле. Идентификатор каталога для получения списка групп узлов. Чтобы получить идентификатор каталога, используйте запрос list.
pageSize	Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
pageToken	Токен страницы. Установите значение `page_token` равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter	Параметры фильтрации ресурсов в ответе. В параметрах фильтрации указываются: 1. Имя поля. В настоящее время фильтрация осуществляется только по полю NodeGroup.name. 2. Оператор. Операторы `=` или `!=` для одиночных значений, `IN` или `NOT IN` для списков значений. 3. Значение. Значение длиной от 1 до 61 символов, совпадающее с регулярным выражением `^[a-z][-a-z0-9]{1,61}[a-z0-9]$`. Максимальная длина строки в символах — 1000.

Ответ

HTTP Code: 200 - OK

{
  "nodeGroups": [
    {
      "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": {

        // `nodeGroups[].scalePolicy` включает только одно из полей `fixedScale`, `autoScale`
        "fixedScale": {
          "size": "string"
        },
        "autoScale": {
          "minSize": "string",
          "maxSize": "string",
          "initialSize": "string"
        },
        // конец списка возможных полей`nodeGroups[].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": {

          // `nodeGroups[].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"
              }
            ]
          },
          // конец списка возможных полей`nodeGroups[].maintenancePolicy.maintenanceWindow`

        }
      },
      "allowedUnsafeSysctls": [
        "string"
      ]
    }
  ],
  "nextPageToken": "string"
}

Поле	Описание
nodeGroups[]	object Список групп узлов.
nodeGroups[]. id	string Идентификатор группы узлов.
nodeGroups[]. clusterId	string Идентификатор кластера, к которому принадлежит группа узлов.
nodeGroups[]. createdAt	string (date-time) Время создания. Строка в формате RFC3339.
nodeGroups[]. name	string Новое имя группы узлов. Имя уникально в рамках каталога.
nodeGroups[]. description	string Новое описание группы узлов. Длина описания должна быть от 0 до 256 символов.
nodeGroups[]. labels	object Метки ресурса в формате `key:value`. Максимум 64 метки на ресурс.
nodeGroups[]. status	string Статус группы узлов. PROVISIONING: Группа узлов ожидает выделения ресурсов. RUNNING: Группа узлов запущена. RECONCILING: Группа узлов ожидает выполнения некоторых работ, например, обновления программного обеспечения узла. STOPPING: Группа узлов останавливается. STOPPED: Группа узлов остановлена. DELETING: Группа узлов удаляется. STARTING: Группа узлов запускается.
nodeGroups[]. nodeTemplate	object Шаблон узла, задающий параметры вычислительных экземпляров для группы узлов.
nodeGroups[]. nodeTemplate. platformId	string Идентификатор аппаратной платформы виртуальной машины.
nodeGroups[]. nodeTemplate. resourcesSpec	object Вычислительные ресурсы узла, такие как объем памяти и количество ядер.
nodeGroups[]. nodeTemplate. resourcesSpec. memory	string (int64) Объем памяти в байтах, доступный виртуальной машине. Допустимые значения — от 0 до 274877906944 включительно.
nodeGroups[]. nodeTemplate. resourcesSpec. cores	string (int64) Количество ядер, доступное узлу. Значение должно быть равно 0, 1, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30 или 32.
nodeGroups[]. nodeTemplate. resourcesSpec. coreFraction	string (int64) Базовый уровень производительности CPU с возможностью повышения производительности выше этого уровня. Это поле устанавливает базовую производительность для каждого ядра. Значение должно быть равно 0, 5, 20, 50 или 100.
nodeGroups[]. nodeTemplate. bootDiskSpec	object Спецификация загрузочного диска, который будет подключен к узлу.
nodeGroups[]. nodeTemplate. bootDiskSpec. diskTypeId	string Идентификатор типа диска. Значение должно соответствовать регулярному выражению `\\|network-ssd\\|network-hdd`.
nodeGroups[]. nodeTemplate. bootDiskSpec. diskSize	string (int64) Размер диска в байтах. Допустимые значения — от 0 до 4398046511104 включительно.
nodeGroups[]. nodeTemplate. metadata	object Метаданные, назначаемые этому шаблону виртуальной машины, в формате `key:value`. Сюда входят пользовательские метаданные и предопределенные ключи. Например, вы можете использовать метаданные для предоставления вашего открытого SSH-ключа узлу. Дополнительные сведения см. в разделе Metadata. Не более 128 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению `[a-z][-_0-9a-z]*`. Максимальная длина строки в символах для каждого значения — 262144.
nodeGroups[]. nodeTemplate. v4AddressSpec	object Спецификация для создания сетевых интерфейсов для вычислительных экземпляров группы узлов.
nodeGroups[]. nodeTemplate. v4AddressSpec. oneToOneNatSpec	object Конфигурация one-to-one NAT. Настройка one-to-one NAT гарантирует, что узлам будут назначены публичные IP-адреса. Поэтому интернет будет доступен на всех узлах группы узлов. Если поле не задано, NAT не будет настроен.
nodeGroups[]. nodeTemplate. v4AddressSpec. oneToOneNatSpec. ipVersion	string Версия IP для публичного IP-адреса. IPV4: IPv4-адрес, например 192.168.0.0. IPV6: IPv6-адрес, на данный момент не доступен.
nodeGroups[]. nodeTemplate. schedulingPolicy	object Политика планирования.
nodeGroups[]. nodeTemplate. schedulingPolicy. preemptible	boolean (boolean) Если значение равно `true` — будет создана прерываемая виртуальная машина. Значение по умолчанию: `false`. Прерываемые виртуальные машины будут принудительно остановлены в срок, не превышающий 24 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Preemptible Virtual Machines.
nodeGroups[]. scalePolicy	object Политика масштабирования группы узлов. Дополнительные сведения см. в разделе Scaling policy.
nodeGroups[]. scalePolicy. fixedScale	object Политика масштабирования группы узлов. `nodeGroups[].scalePolicy` включает только одно из полей `fixedScale`, `autoScale`
nodeGroups[]. scalePolicy. fixedScale. size	string (int64) Количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно.
nodeGroups[]. scalePolicy. autoScale	object Политика масштабирования группы узлов. `nodeGroups[].scalePolicy` включает только одно из полей `fixedScale`, `autoScale`
nodeGroups[]. scalePolicy. autoScale. minSize	string (int64) Минимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно.
nodeGroups[]. scalePolicy. autoScale. maxSize	string (int64) Максимальное количество узлов в группе узлов. Допустимые значения — от 0 до 100 включительно.
nodeGroups[]. scalePolicy. autoScale. initialSize	string (int64) Начальный размер группы узлов. Допустимые значения — от 0 до 100 включительно.
nodeGroups[]. allocationPolicy	object Политика распределения, с помощью которой ресурсы для групп узлов распределяются по зонам и регионам.
nodeGroups[]. allocationPolicy. locations[]	object Список местоположений (зон доступности и подсетей), в которых будут выделены ресурсы для группы узлов.
nodeGroups[]. allocationPolicy. locations[]. zoneId	string Обязательное поле. Идентификатор зоны доступности, в которой могут находиться узлы.
nodeGroups[]. allocationPolicy. locations[]. subnetId	string Идентификатор подсети. Если сеть, выбранная для кластера Kubernetes, имеет только одну подсеть в указанной зоне, идентификатор подсети может быть опущен.
nodeGroups[]. instanceGroupId	string Идентификатор группы виртуальных машин, связанной с этой группой узлов.
nodeGroups[]. nodeVersion	string Версия компонентов Kubernetes, которая запущена на узлах. Устарел. Используйте version_info.current_version.
nodeGroups[]. versionInfo	object Подробная информация о версии Kubernetes, которая запущена на мастере.
nodeGroups[]. versionInfo. currentVersion	string Текущая версия Kubernetes, формат: major.minor (например, 1.15).
nodeGroups[]. versionInfo. newRevisionAvailable	boolean (boolean) Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах.
nodeGroups[]. versionInfo. newRevisionSummary	string Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле `new_revision_available` имеет значение `false`.
nodeGroups[]. versionInfo. versionDeprecated	boolean (boolean) Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен.
nodeGroups[]. maintenancePolicy	object Политика обновления группы узлов.
nodeGroups[]. maintenancePolicy. autoUpgrade	boolean (boolean) Если установлено значение `true`, автоматическое обновление устанавливается без участия пользователя в заданный промежуток времени. Если установлено значение `false`, автоматическое обновление отключено.
nodeGroups[]. maintenancePolicy. autoRepair	boolean (boolean) Если установлено значение `true`, автоматическое восстановление включено. Значение по умолчанию: `false`.
nodeGroups[]. maintenancePolicy. maintenanceWindow	object Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.
nodeGroups[]. maintenancePolicy. maintenanceWindow. anytime	object Обновление мастера в любое время. `nodeGroups[].maintenancePolicy.maintenanceWindow` включает только одно из полей `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
nodeGroups[]. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow	object Обновление мастера в любой день в течение указанного временного окна. `nodeGroups[].maintenancePolicy.maintenanceWindow` включает только одно из полей `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
nodeGroups[]. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime	object Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. Время суток. Дата и часовой пояс либо не учитываются, либо задаются в других местах. API может разрешить использование високосной секунды. Связанные типы: google.type.Date и google.protobuf.Timestamp.
nodeGroups[]. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. hours	integer (int32) Часы. Допустимые значения: от 0 до 23. API может разрешить использовать значение в формате "24:00:00" в требующих этого сценариях (например, для указания времени закрытия учреждения).
nodeGroups[]. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. minutes	integer (int32) Минуты. Допустимые значения: от 0 до 59.
nodeGroups[]. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. seconds	integer (int32) Секунды. Стандартные допустимые значения: от 0 до 59. API может разрешить использовать значение 60, если также разрешено использование високосной секунды.
nodeGroups[]. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. startTime. nanos	integer (int32) Доли секунды (в наносекундах). Допустимые значения: от 0 до 999999999.
nodeGroups[]. maintenancePolicy. maintenanceWindow. dailyMaintenanceWindow. duration	string Длительность окна обновлений. Допустимые значения — от 3600 seconds до 86400 seconds включительно.
nodeGroups[]. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow	object Обновление мастера в выбранные дни в течение указанного временного окна. `nodeGroups[].maintenancePolicy.maintenanceWindow` включает только одно из полей `anytime`, `dailyMaintenanceWindow`, `weeklyMaintenanceWindow`
nodeGroups[]. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]	object Обязательное поле. Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления. Количество элементов должно находиться в диапазоне от 1 до 7.
nodeGroups[]. 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.
nodeGroups[]. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime	object Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC. Время суток. Дата и часовой пояс либо не учитываются, либо задаются в других местах. API может разрешить использование високосной секунды. Связанные типы: google.type.Date и google.protobuf.Timestamp.
nodeGroups[]. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. hours	integer (int32) Часы. Допустимые значения: от 0 до 23. API может разрешить использовать значение в формате "24:00:00" в требующих этого сценариях (например, для указания времени закрытия учреждения).
nodeGroups[]. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. minutes	integer (int32) Минуты. Допустимые значения: от 0 до 59.
nodeGroups[]. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. seconds	integer (int32) Секунды. Стандартные допустимые значения: от 0 до 59. API может разрешить использовать значение 60, если также разрешено использование високосной секунды.
nodeGroups[]. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. startTime. nanos	integer (int32) Доли секунды (в наносекундах). Допустимые значения: от 0 до 999999999.
nodeGroups[]. maintenancePolicy. maintenanceWindow. weeklyMaintenanceWindow. daysOfWeek[]. duration	string Длительность окна обновлений. Допустимые значения — от 3600 seconds до 86400 seconds включительно.
nodeGroups[]. allowedUnsafeSysctls[]	string Поддержка параметров unsafe sysctl. Дополнительные сведения см. в documentation.
nextPageToken	string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте `next_page_token` в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения `next_page_token` для перебора страниц результатов.