Метод list

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

HTTP-запрос

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

Query-параметры

Параметр Описание
folderId Обязательное поле. Идентификатор каталога для получения списка групп узлов. Чтобы получить идентификатор каталога, используйте запрос list.
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
pageToken Токен страницы. Установите значение pageToken равным значению поля 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": {
        "fixedScale": {
          "size": "string"
        }
      },
      "allocationPolicy": {
        "locations": [
          {
            "zoneId": "string",
            "subnetId": "string"
          }
        ]
      },
      "instanceGroupId": "string",
      "nodeVersion": "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: Группа узлов удаляется.
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

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

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

nodeGroups[].
nodeTemplate.
bootDiskSpec.
diskTypeId
string

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

Значение должно соответствовать регулярному выражению |network-nvme|network-hdd.

nodeGroups[].
nodeTemplate.
bootDiskSpec.
diskSize
string (int64)

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

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

nodeGroups[].
nodeTemplate.
metadata
object

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

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 часа с момента их создания. Остановленные виртуальные машины можно запустить повторно, без потери данных. Дополнительные сведения см. в разделе Прерываемые виртуальные машины.

nodeGroups[].
scalePolicy
object

Политика масштабирования группы узлов. Дополнительные сведения см. в разделе Политика масштабирования.

nodeGroups[].
scalePolicy.
fixedScale
object
Политика масштабирования группы узлов.
nodeGroups[].
scalePolicy.
fixedScale.
size
string (int64)

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

Минимальное значение — 1.

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, которая запущена на узлах.

nextPageToken string

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.