Метод get

Возвращает указанный кластер Kubernetes.

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

HTTP-запрос

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

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор возвращаемого кластера Kubernetes.

Ответ

HTTP Code: 200 - OK

{
  "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"
}

Кластер Kubernetes.

Поле Описание
id string

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

folderId string

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

createdAt string (date-time)

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

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

name string

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

description string

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

labels object

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

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

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

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

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

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

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

master.
endpoints.
externalV4Endpoint
string

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

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

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

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

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

master.
zonalMaster.
internalV4Address
string

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

master.
zonalMaster.
externalV4Address
string

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

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

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

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

ipAllocationPolicy.
serviceIpv4CidrBlock
string

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

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

serviceAccountId string

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

nodeServiceAccountId string

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

gatewayIpv4Address string

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