ListNodegroups#

Description#

Возвращает список имён групп рабочих узлов, связанных с указанным кластером Kubernetes.

Request Syntax#

GET /clusters/name/node-groups?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters#

В запросе используются следующие параметры URI.

  • maxResults — Максимальное количество имён групп рабочих узлов, описание которых возвращает ListNodegroups в постраничном выводе.

    • Необходимо: Нет

    • Тип: Integer

    • Диапазон значений: Минимум — 1. Максимум — 100.

    • Значение по умолчанию: 100

  • name — Имя кластера, для которого требуется вывести список имён групп рабочих узлов.

    • Тип: String

    • Необходимо: Да

  • nextToken — Значение nextToken из предыдущего вызова (см. Response Elements).

    • Тип: String

    • Необходимо: Нет

Request Parameters#

Тело запроса отсутствует.

Response Syntax#

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "nodegroups": [ "string" ]
}

Response Elements#

В случае успешного выполнения запроса API вернёт HTTP-ответ с кодом 200. В ответе содержатся следующие данные в формате JSON.

  • nextToken — Токен возвращается только в том случае, когда не удалось вернуть все имена групп рабочих узлов, удовлетворяющие критериям. Чтобы продолжить вывод данных, полученное значение нужно передать в параметре nextToken такого же запроса.

    • Тип: String

  • nodegroups — Список имён всех групп рабочих узлов, связанных с указанным кластером.

    • Тип: List of strings

Examples#

Для управления кластерами Kubernetes в К2 Облаке с помощью API необходима кастомизированная версия библиотеки boto3:

boto3 K2 Cloud boto3 Client
import boto3

session = boto3.Session(
   aws_access_key_id="<AWS_ACCESS_KEY_ID>",
   aws_secret_access_key="<AWS_SECRET_ACCESS_KEY>",
   region_name="",
)

eks_client = session.client(
   'eks',
   endpoint_url='https://eks.k2.cloud/',
)

eks_client.list_nodegroups(clusterName="production")
c2-eks K2 Cloud API Client
c2-eks ListNodegroups clusterName production
aws-cli
aws eks --endpoint https://eks.k2.cloud/ list-nodegroups --cluster-name production