Метод list

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

HTTP-запрос

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

Query-параметры

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

Ответ

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "status": "string",
      "health": "string",
      "networkId": "string",
      "master": {
        "version": "string",
        "endpoints": {
          "internalV4Endpoint": "string",
          "externalV4Endpoint": "string"
        },
        "masterAuth": {
          "clusterCaCertificate": "string"
        },
        "zonalMaster": {
          "zoneId": "string",
          "internalV4Address": "string",
          "externalV4Address": "string"
        }
      },
      "ipAllocationPolicy": {
        "clusterIpv4CidrBlock": "string",
        "serviceIpv4CidrBlock": "string"
      },
      "serviceAccountId": "string",
      "nodeServiceAccountId": "string",
      "gatewayIpv4Address": "string"
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
clusters[] object

Кластер Kubernetes.

clusters[].
id
string

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

clusters[].
folderId
string

Идентификатор каталога, которому принадлежит кластер Kubernetes.

clusters[].
createdAt
string (date-time)

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

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

clusters[].
name
string

Имя кластера Kubernetes.

clusters[].
description
string

Описание кластера Kubernetes. Длина описания должна быть от 0 до 256 символов.

clusters[].
labels
object

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

clusters[].
status
string
Статус кластера Kubernetes.
  • PROVISIONING: Кластер Kubernetes ожидает выделения ресурсов.
  • RUNNING: Кластер Kubernetes запущен.
  • RECONCILING: Кластер Kubernetes согласовывается.
  • STOPPING: Кластер Kubernetes останавливается.
  • STOPPED: Кластер Kubernetes остановлен.
  • DELETING: Кластер Kubernetes удаляется.
clusters[].
health
string
Состояние кластера Kubernetes.
  • HEALTHY: Кластер Kubernetes работает нормально.
  • UNHEALTHY: Кластер Kubernetes не работает и не может выполнять свои основные функции.
clusters[].
networkId
string

Идентификатор облачной сети, к которой принадлежит кластер Kubernetes.

clusters[].
master
object
Свойства мастера для кластера Kubernetes.
clusters[].
master.
version
string

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

clusters[].
master.
endpoints
object
Эндпойнт мастера. Эндпойнты состоят из схемы и порта (т. е. https://ip-address:port) и могут использоваться клиентами для связи с API Kubernetes кластера Kubernetes.
clusters[].
master.
endpoints.
internalV4Endpoint
string

Внутренний эндпойнт, который может использоваться для подключения к мастеру из облачных сетей.

clusters[].
master.
endpoints.
externalV4Endpoint
string

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

clusters[].
master.
masterAuth
object
Параметры, используемые для аутентификации мастера.
clusters[].
master.
masterAuth.
clusterCaCertificate
string

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

clusters[].
master.
zonalMaster
object
Параметры зоны доступности мастера.
clusters[].
master.
zonalMaster.
zoneId
string

Идентификатор зоны доступности, в которой находится мастер.

clusters[].
master.
zonalMaster.
internalV4Address
string

Внутренний IPv4-адрес, назначенный мастеру.

clusters[].
master.
zonalMaster.
externalV4Address
string

Внешний IPv4-адрес , назначенный мастеру.

clusters[].
ipAllocationPolicy
object
Политика распределения IP-адресов для служб и модулей внутри кластера Kubernetes в разных зонах доступности.
clusters[].
ipAllocationPolicy.
clusterIpv4CidrBlock
string

CIDR. Диапазон IP-адресов для подов.

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

clusters[].
ipAllocationPolicy.
serviceIpv4CidrBlock
string

CIDR. Диапазон IP-адресов для сервисов.

Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes.

clusters[].
serviceAccountId
string

Сервисный аккаунт, используемый для выделения Compute Cloud и VPC ресурсов для кластера Kubernetes.

clusters[].
nodeServiceAccountId
string

Сервисный аккаунт, используемый узлами кластера Kubernetes для доступа к Container Registry или для загрузки логов и метрик узла.

clusters[].
gatewayIpv4Address
string

Адрес шлюза IPv4.

nextPageToken string

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