Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Managed Service for Kubernetes
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Подключение к узлу по SSH
    • Создание файла конфигурации
    • Сетевые сценарии
      • Обеспечение доступа к приложению, запущенному в кластере Kubernetes
      • Работа с сетевыми политиками кластера Kubernetes
    • Шифрование секретов
    • Работа с постоянными томами
      • Динамическая подготовка тома
      • Статическая подготовка тома
      • Управление классами хранилищ
      • Увеличение размера тома
      • Подключение тома в блочном режиме
    • Управление кластером Kubernetes
      • Добавление учетных данных кластера Kubernetes в конфигурационный файл kubectl
      • Получение информации о кластере Kubernetes
      • Создание кластера Kubernetes
      • Изменение кластера Kubernetes
      • Удаление кластера Kubernetes
    • Управление группой узлов
      • Получение информации о группе узлов
      • Создание группы узлов
      • Изменение группы узлов
      • Удаление группы узлов
  • Сценарии использования
    • Интеграция с Container Registry
    • Запуск рабочих нагрузок с GPU
    • Резервное копирование в Object Storage
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Релизные каналы и обновления
    • Использование объектов API Kubernetes
      • Том
      • Сервис
    • Группа узлов
      • Автоматическое масштабирование группы узлов
      • Расселение подов с узла
      • Динамическое резервирование ресурсов для узла
      • Группы узлов с GPU
    • Сетевые политики кластера Kubernetes
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • ClusterService
      • NodeGroupService
      • VersionService
      • OperationService
    • REST
      • Обзор
      • Cluster
        • Обзор
        • create
        • delete
        • get
        • list
        • listNodeGroups
        • listOperations
        • update
      • NodeGroup
        • Обзор
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • Version
        • Обзор
        • list
  • Вопросы и ответы
  1. Справочник API
  2. REST
  3. Cluster
  4. get

Метод get

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

Возвращает указанный кластер 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"
    },
    "versionInfo": {
      "currentVersion": "string",
      "newRevisionAvailable": true,
      "newRevisionSummary": "string",
      "versionDeprecated": true
    },
    "maintenancePolicy": {
      "autoUpgrade": true,
      "maintenanceWindow": {

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

      }
    },

    // `master` включает только одно из полей `zonalMaster`, `regionalMaster`
    "zonalMaster": {
      "zoneId": "string",
      "internalV4Address": "string",
      "externalV4Address": "string"
    },
    "regionalMaster": {
      "regionId": "string",
      "internalV4Address": "string",
      "externalV4Address": "string"
    },
    // конец списка возможных полей`master`

  },
  "ipAllocationPolicy": {
    "clusterIpv4CidrBlock": "string",
    "serviceIpv4CidrBlock": "string"
  },
  "serviceAccountId": "string",
  "nodeServiceAccountId": "string",
  "releaseChannel": "string",
  "networkPolicy": {
    "provider": "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 удаляется.
  • STARTING: Кластер 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.
versionInfo
object
Подробная информация о версии Kubernetes, которая запущена на мастере.
master.
versionInfo.
currentVersion
string

Текущая версия Kubernetes, формат: major.minor (например, 1.15).

master.
versionInfo.
newRevisionAvailable
boolean (boolean)

Новые версии могут включать патчи Kubernetes (например, 1.15.1 -> 1.15.2), а также некоторые обновления внутренних компонентов — новые функции или исправления ошибок в конкретных компонентах Яндекса на мастере или на узлах.

master.
versionInfo.
newRevisionSummary
string

Описание изменений, которые будут применены при обновлении до последней версии. Пусто, если поле new_revision_available имеет значение false.

master.
versionInfo.
versionDeprecated
boolean (boolean)

Текущая версия устарела, компонент кластера Kubernetes (мастер или группа узлов) должен быть обновлен.

master.
maintenancePolicy
object
Политика обновления мастера.
master.
maintenancePolicy.
autoUpgrade
boolean (boolean)

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

master.
maintenancePolicy.
maintenanceWindow
object

Настройки окна обновления. Обновление начнется в указанное время и продлится не более указанного времени. Время устанавливается в формате UTC.

master.
maintenancePolicy.
maintenanceWindow.
anytime
object
Обновление мастера в любое время.
master.maintenancePolicy.maintenanceWindow включает только одно из полей anytime, dailyMaintenanceWindow, weeklyMaintenanceWindow

master.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow
object
Обновление мастера в любой день в течение указанного временного окна.
master.maintenancePolicy.maintenanceWindow включает только одно из полей anytime, dailyMaintenanceWindow, weeklyMaintenanceWindow

master.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime
object

Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.

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

API может разрешить использование високосной секунды.

Связанные типы: google.type.Date и google.protobuf.Timestamp.

master.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
hours
integer (int32)

Часы. Допустимые значения: от 0 до 23.

API может разрешить использовать значение в формате "24:00:00" в требующих этого сценариях (например, для указания времени закрытия учреждения).

master.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
minutes
integer (int32)

Минуты. Допустимые значения: от 0 до 59.

master.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
seconds
integer (int32)

Секунды. Стандартные допустимые значения: от 0 до 59.

API может разрешить использовать значение 60, если также разрешено использование високосной секунды.

master.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
startTime.
nanos
integer (int32)

Доли секунды (в наносекундах). Допустимые значения: от 0 до 999999999.

master.
maintenancePolicy.
maintenanceWindow.
dailyMaintenanceWindow.
duration
string

Длительность окна обновлений.

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

master.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow
object
Обновление мастера в выбранные дни в течение указанного временного окна.
master.maintenancePolicy.maintenanceWindow включает только одно из полей anytime, dailyMaintenanceWindow, weeklyMaintenanceWindow

master.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[]
object

Обязательное поле. Дни недели и окно обновлений для этих дней, когда разрешены автоматические обновления.

Количество элементов должно находиться в диапазоне от 1 до 7.

master.
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.
master.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime
object

Обязательное поле. Время начала окна обновлений, указывается в часовом поясе UTC.

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

API может разрешить использование високосной секунды.

Связанные типы: google.type.Date и google.protobuf.Timestamp.

master.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
hours
integer (int32)

Часы. Допустимые значения: от 0 до 23.

API может разрешить использовать значение в формате "24:00:00" в требующих этого сценариях (например, для указания времени закрытия учреждения).

master.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
minutes
integer (int32)

Минуты. Допустимые значения: от 0 до 59.

master.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
seconds
integer (int32)

Секунды. Стандартные допустимые значения: от 0 до 59.

API может разрешить использовать значение 60, если также разрешено использование високосной секунды.

master.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
startTime.
nanos
integer (int32)

Доли секунды (в наносекундах). Допустимые значения: от 0 до 999999999.

master.
maintenancePolicy.
maintenanceWindow.
weeklyMaintenanceWindow.
daysOfWeek[].
duration
string

Длительность окна обновлений.

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

master.
zonalMaster
object
Параметры зоны доступности мастера.
master включает только одно из полей zonalMaster, regionalMaster

master.
zonalMaster.
zoneId
string

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

master.
zonalMaster.
internalV4Address
string

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

master.
zonalMaster.
externalV4Address
string

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

master.
regionalMaster
object
Параметры региона для мастера.
master включает только одно из полей zonalMaster, regionalMaster

master.
regionalMaster.
regionId
string

Идентификатор региона, в котором находится мастер.

master.
regionalMaster.
internalV4Address
string

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

master.
regionalMaster.
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 или для загрузки логов и метрик узла.

releaseChannel string
При создании кластера Kubernetes вы должны указать один из трех релизных каналов. Релизный канал содержит несколько версий Kubernetes. Каналы отличаются набором доступных версий, управлением автоматическими обновлениями и получаемыми обновлениями. Изменить канал после создания кластера Kubernetes нельзя, возможно только пересоздать кластер Kubernetes и указать новый релизный канал. Дополнительные сведения см. в documentation.
  • RAPID: На канале часто появляются минорные обновления, содержащие новую функциональность и улучшения. Вы не можете отключить автоматическое обновление на этом канале, но вы можете указать период времени для автоматического обновления.
  • REGULAR: Новая функциональность и улучшения порциями попадают на канал через некоторое время после того, как были предоставлены на канале RAPID.
  • STABLE: На канале происходят только обновления, касающиеся исправление ошибок или улучшения безопасности.
networkPolicy object
networkPolicy.
provider
string
gatewayIpv4Address string

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

Максимальная длина строки в символах — 15.

В этой статье:
  • HTTP-запрос
  • Path-параметры
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»