- tocdepth
2
Кластер
В разделе описаны методы создания и удаления кластера, а также просмотра информации о нем.
- GET /v2/clusters
Получение списка кластеров.
- Query Parameters
limit (integer) – Количество кластеров в ответе.
offset (integer) – Количество пропущенных кластеров.
sort (string) – Сортировка списка кластеров в виде «field direction». Возможные значения для field: displayName, masterCount, nodePoolCount, createdAt. Возможные значения для direction: asc, desc.
filters (array) – Параметры фильтрации списка кластеров в виде «field condition value» или «field:value»(include). Возможные значения для field: displayName, state, kubeAPIInternet, masterCount, nodePoolCount, createdAt. Возможные значения для condition: =, !=, >, >=, <, <=.
projectId (string) – Идентификатор проекта.
- Status Codes
200 OK – A successful response.
- Response JSON Object
items (array) – Список кластеров.
items[].clusterId (string) – Идентификатор кластера, присваивается автоматически при создании кластера.
items[].controlPlane (object) – Конфигурация плоскости управления.
items[].controlPlane.count (integer) – Количество узлов плоскости управления.
items[].controlPlane.multizonal (boolean) – Флаг поддержки мультизональности. Зависит от поля zones. Если зоны не указаны и флаг отключен, используется случайная зона из шаблона конфигураций для ВМ, подходящий под MasterType. Если зоны не указаны и флаг включен, используются все зоны в которых поддерживается шаблон конфигурации для ВМ, подходящий под MasterType. Если зоны указаны и флаг отключен, используется первая зона из списка zones. Если зоны указаны и флаг включен, используются зоны из списка zones.
items[].controlPlane.type (string) – Тип узла плоскости управления.
items[].controlPlane.version (string) – Версия Kubernetes.
items[].controlPlane.zones (array) – Опциональное поле. Взаимодействует с флагом multizonal. Указывает, в каких зонах будут размещены узлы управления.
items[].controlPlane.zones[] (string) – Зона размещения узлов управления.
items[].createdAt (string) – Время создания кластера, присваивается автоматически при создании кластера.
items[].createdBy (string) – Идентификатор пользователя, создавшего кластер.
items[].displayName (string) – Название кластера, которое ввел пользователь.
items[].loggingService (object) – Параметры логирования событий компонентов кластера.
items[].loggingService.enabled (boolean) – Включение/выключение логирования событий компонентов кластера. Возможные значения: true — логирование включено, false — логирование выключено. По умолчанию логирование включено. Если установлен параметр false, настройки лог-группы игнорируются.
items[].loggingService.logGroupId (string) – Идентификатор лог-группы. Опциональное поле. Если не указывается, используется значение по умолчанию.
items[].monitoringService (object) – Параметры мониторинга компонентов кластера.
items[].monitoringService.enabled (boolean) – Включение/выключение мониторинга компонентов кластера. Возможные значения: true — мониторинг включен, false — мониторинг выключен. По умолчанию мониторинг включен.
items[].networkConfiguration (object) – Сетевая конфигурация кластера (обязательное поле).
items[].networkConfiguration.cpEndpoints (array) – Адреса плоскости управления.
items[].networkConfiguration.cpEndpoints[].address (string) – Адрес плоскости управления кластера в формате «https://domain:port».
items[].networkConfiguration.cpEndpoints[].network (string) – Тип сети, которой принадлежит адрес.
items[].networkConfiguration.kubeApiInternet (boolean) – Флаг публикации kube-apiserver в интернет.
items[].networkConfiguration.nodesSubnetCidr (string) – Адрес подсети узлов плоскости управления.
items[].networkConfiguration.nodesSubnetId (string) – Идентификатор подсети узлов плоскости управления.
items[].networkConfiguration.podsSubnetCidr (string) – Адрес подсети подов.
items[].networkConfiguration.servicesSubnetCidr (string) – Адрес подсети сервисов.
items[].networkConfiguration.vpcId (string) – Идентификатор VPC.
items[].nodePoolsInfo (object) – Информация по группам узлов.
items[].nodePoolsInfo.count (integer) – Количество групп узлов.
items[].nodePoolsInfo.cpu (integer) – Количество ядер процессора виртуальных машин.
items[].nodePoolsInfo.diskSize (integer) – Размер подключаемых дисков в ГБ.
items[].nodePoolsInfo.ram (integer) – Оперативная память виртуальных машин в ГБ.
items[].state (string) – Состояние узла.
items[].updatedAt (string) – Время последнего редактирования кластера.
items[].updatedBy (string) – Идентификатор последнего пользователя, редактировавшего кластер.
limit (integer) – Количество кластеров в ответе.
offset (integer) – Количество пропущенных кластеров.
projectId (string) – Идентификатор проекта.
total (integer) – Общее число кластеров.
- POST /v2/clusters
Создание нового кластера.
- Request JSON Object
addons (array) – Список плагинов для установки сразу же после создания кластера.
addons[].addonName (string) – Машинное имя ресурса. Обязательное поле.
addons[].addonVersion (string) – Версия плагина в формате SemVer. Если версия не указана, то она будет выбрана автоматически.
controlPlane (object) – Конфигурация плоскости управления.
controlPlane.count (integer) – Количество узлов плоскости управления.
controlPlane.multizonal (boolean) – Флаг поддержки мультизональности. Зависит от поля zones. Если зоны не указаны и флаг отключен, используется случайная зона из шаблона конфигураций для ВМ, подходящий под MasterType. Если зоны не указаны и флаг включен, используются все зоны в которых поддерживается шаблон конфигурации для ВМ, подходящий под MasterType. Если зоны указаны и флаг отключен, используется первая зона из списка zones. Если зоны указаны и флаг включен, используются зоны из списка zones.
controlPlane.type (string) – Тип узла плоскости управления.
controlPlane.version (string) – Версия Kubernetes.
controlPlane.zones (array) – Опциональное поле. Взаимодействует с флагом multizonal. Указывает, в каких зонах будут размещены узлы управления.
controlPlane.zones[] (string) – Зона размещения узлов управления.
displayName (string) – Название кластера. Может содержать буквы, цифры, дефис, подчеркивание. Допустимое количество символов от 3 до 60.
loggingService (object) – Параметры логирования событий компонентов кластера.
loggingService.enabled (boolean) – Включение/выключение логирования событий компонентов кластера. Возможные значения: true — логирование включено, false — логирование выключено. По умолчанию логирование включено. Если установлен параметр false, настройки лог-группы игнорируются.
loggingService.logGroupId (string) – Идентификатор лог-группы. Опциональное поле. Если не указывается, используется значение по умолчанию.
monitoringService (object) – Параметры мониторинга компонентов кластера.
monitoringService.enabled (boolean) – Включение/выключение мониторинга компонентов кластера. Возможные значения: true — мониторинг включен, false — мониторинг выключен. По умолчанию мониторинг включен.
networkConfiguration (object) – Сетевая конфигурация кластера и плоскости управления.
networkConfiguration.kubeApiInternet (boolean) – Флаг публикации kube-apiserver в интернет.
networkConfiguration.nodesSubnetCidr (string) – Адрес подсети узлов в формате RFC1918. Если указать это значение, то сеть будет создана автоматически.
networkConfiguration.nodesSubnetId (string) – Идентификатор существующей подсети узлов.
networkConfiguration.podsSubnetCidr (string) – Адрес сети подов в формате RFC1918.
networkConfiguration.servicesSubnetCidr (string) – Адрес подсети сервисов в формате RFC1918.
networkConfiguration.vpcId (string) – Идентификатор VPC.
projectId (string) – Идентификатор проекта.
- Status Codes
200 OK – A successful response.
- Response JSON Object
task (object) – Информация о задаче.
task.createdAt (string) – Время создания задачи.
task.data (object) – Данные, если задача завершилась успешно.
task.data.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error (object) – Ошибка, если задача завершилась с ошибкой.
task.error.code (integer) – Код состояния.
task.error.details (array) – Список сообщений, содержащих сведения об ошибке.
task.error.details[].@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error.message (string) – Сообщение об ошибке.
task.eventName (string) – Тип события.
task.id (string) – Идентификатор задачи.
task.metadata (object) – Данные, если задача завершилась успешно.
task.metadata.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.status (string) – Статус задачи.
task.taskObjectId (string) – Идентификатор объекта задачи.
task.taskObjectType (string) – Тип объекта задачи.
task.updatedAt (string) – Время последнего обновления задачи.
task.userId (string) – Идентификатор пользователя.
- GET /v2/clusters/{clusterId}
Получение информации о кластере.
- Parameters
clusterId (string) – Идентификатор кластера.
- Status Codes
200 OK – A successful response.
- Response JSON Object
cluster (object) – Информация о кластере.
cluster.clusterId (string) – Идентификатор кластера, присваивается автоматически при создании кластера.
cluster.controlPlane (object) – Конфигурация плоскости управления.
cluster.controlPlane.count (integer) – Количество узлов плоскости управления.
cluster.controlPlane.multizonal (boolean) – Флаг поддержки мультизональности. Зависит от поля zones. Если зоны не указаны и флаг отключен, используется случайная зона из шаблона конфигураций для ВМ, подходящий под MasterType. Если зоны не указаны и флаг включен, используются все зоны в которых поддерживается шаблон конфигурации для ВМ, подходящий под MasterType. Если зоны указаны и флаг отключен, используется первая зона из списка zones. Если зоны указаны и флаг включен, используются зоны из списка zones.
cluster.controlPlane.type (string) – Тип узла плоскости управления.
cluster.controlPlane.version (string) – Версия Kubernetes.
cluster.controlPlane.zones (array) – Опциональное поле. Взаимодействует с флагом multizonal. Указывает, в каких зонах будут размещены узлы управления.
cluster.controlPlane.zones[] (string) – Зона размещения узлов управления.
cluster.createdAt (string) – Время создания кластера, присваивается автоматически при создании кластера.
cluster.createdBy (string) – Идентификатор пользователя, создавшего кластер.
cluster.displayName (string) – Название кластера, которое ввел пользователь.
cluster.loggingService (object) – Параметры логирования событий компонентов кластера.
cluster.loggingService.enabled (boolean) – Включение/выключение логирования событий компонентов кластера. Возможные значения: true — логирование включено, false — логирование выключено. По умолчанию логирование включено. Если установлен параметр false, настройки лог-группы игнорируются.
cluster.loggingService.logGroupId (string) – Идентификатор лог-группы. Опциональное поле. Если не указывается, используется значение по умолчанию.
cluster.monitoringService (object) – Параметры мониторинга компонентов кластера.
cluster.monitoringService.enabled (boolean) – Включение/выключение мониторинга компонентов кластера. Возможные значения: true — мониторинг включен, false — мониторинг выключен. По умолчанию мониторинг включен.
cluster.networkConfiguration (object) – Сетевая конфигурация кластера (обязательное поле).
cluster.networkConfiguration.cpEndpoints (array) – Адреса плоскости управления.
cluster.networkConfiguration.cpEndpoints[].address (string) – Адрес плоскости управления кластера в формате «https://domain:port».
cluster.networkConfiguration.cpEndpoints[].network (string) – Тип сети, которой принадлежит адрес.
cluster.networkConfiguration.kubeApiInternet (boolean) – Флаг публикации kube-apiserver в интернет.
cluster.networkConfiguration.nodesSubnetCidr (string) – Адрес подсети узлов плоскости управления.
cluster.networkConfiguration.nodesSubnetId (string) – Идентификатор подсети узлов плоскости управления.
cluster.networkConfiguration.podsSubnetCidr (string) – Адрес подсети подов.
cluster.networkConfiguration.servicesSubnetCidr (string) – Адрес подсети сервисов.
cluster.networkConfiguration.vpcId (string) – Идентификатор VPC.
cluster.nodePoolsInfo (object) – Информация по группам узлов.
cluster.nodePoolsInfo.count (integer) – Количество групп узлов.
cluster.nodePoolsInfo.cpu (integer) – Количество ядер процессора виртуальных машин.
cluster.nodePoolsInfo.diskSize (integer) – Размер подключаемых дисков в ГБ.
cluster.nodePoolsInfo.ram (integer) – Оперативная память виртуальных машин в ГБ.
cluster.state (string) – Состояние узла.
cluster.updatedAt (string) – Время последнего редактирования кластера.
cluster.updatedBy (string) – Идентификатор последнего пользователя, редактировавшего кластер.
projectId (string) – Идентификатор проекта.
- DELETE /v2/clusters/{clusterId}
Удаление кластера.
- Parameters
clusterId (string) – Идентификатор кластера.
- Status Codes
200 OK – A successful response.
- Response JSON Object
task (object) – Информация о задаче.
task.createdAt (string) – Время создания задачи.
task.data (object) – Данные, если задача завершилась успешно.
task.data.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error (object) – Ошибка, если задача завершилась с ошибкой.
task.error.code (integer) – Код состояния.
task.error.details (array) – Список сообщений, содержащих сведения об ошибке.
task.error.details[].@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error.message (string) – Сообщение об ошибке.
task.eventName (string) – Тип события.
task.id (string) – Идентификатор задачи.
task.metadata (object) – Данные, если задача завершилась успешно.
task.metadata.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.status (string) – Статус задачи.
task.taskObjectId (string) – Идентификатор объекта задачи.
task.taskObjectType (string) – Тип объекта задачи.
task.updatedAt (string) – Время последнего обновления задачи.
task.userId (string) – Идентификатор пользователя.
- PATCH /v2/clusters/{clusterId}
Редактирование существующего кластера.
- Parameters
clusterId (string) – Идентификатор кластера.
- Request JSON Object
data (object) – Информацию для редактирования.
data.displayName (string) – Название кластера. Может содержать буквы, цифры, дефис, подчеркивание. Допустимое количество символов от 3 до 60.
data.masterCount (integer) – Количество узлов плоскости управления.
- Status Codes
200 OK – A successful response.
- Response JSON Object
task (object) – Информация о задаче.
task.createdAt (string) – Время создания задачи.
task.data (object) – Данные, если задача завершилась успешно.
task.data.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error (object) – Ошибка, если задача завершилась с ошибкой.
task.error.code (integer) – Код состояния.
task.error.details (array) – Список сообщений, содержащих сведения об ошибке.
task.error.details[].@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error.message (string) – Сообщение об ошибке.
task.eventName (string) – Тип события.
task.id (string) – Идентификатор задачи.
task.metadata (object) – Данные, если задача завершилась успешно.
task.metadata.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.status (string) – Статус задачи.
task.taskObjectId (string) – Идентификатор объекта задачи.
task.taskObjectType (string) – Тип объекта задачи.
task.updatedAt (string) – Время последнего обновления задачи.
task.userId (string) – Идентификатор пользователя.
- GET /v2/clusters/{clusterId}/kubeconfig
Получение kubeconfig для кластера.
- Parameters
clusterId (string) – Идентификатор кластера.
- Query Parameters
network (string) –
Тип сети, для которой запрашивается kubeconfig. Опциональное поле. Если не указано, используется сеть по умолчанию.
NETWORK_TYPE_PRIVATE: Серая пользовательская сеть (RFC1918).
NETWORK_TYPE_PUBLIC: Публичная пользовательская сеть (интернет).
- Status Codes
200 OK – A successful response.
- Response JSON Object
config (string) – Текст kubeconfig в base64.
- POST /v2/clusters/{clusterId}/resume
Возобновление работы кластера.
- Parameters
clusterId (string) – Идентификатор кластера.
- Status Codes
200 OK – A successful response.
- Response JSON Object
task (object) – Информация о задаче.
task.createdAt (string) – Время создания задачи.
task.data (object) – Данные, если задача завершилась успешно.
task.data.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error (object) – Ошибка, если задача завершилась с ошибкой.
task.error.code (integer) – Код состояния.
task.error.details (array) – Список сообщений, содержащих сведения об ошибке.
task.error.details[].@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error.message (string) – Сообщение об ошибке.
task.eventName (string) – Тип события.
task.id (string) – Идентификатор задачи.
task.metadata (object) – Данные, если задача завершилась успешно.
task.metadata.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.status (string) – Статус задачи.
task.taskObjectId (string) – Идентификатор объекта задачи.
task.taskObjectType (string) – Тип объекта задачи.
task.updatedAt (string) – Время последнего обновления задачи.
task.userId (string) – Идентификатор пользователя.
- POST /v2/clusters/{clusterId}/stop
Приостановка кластера.
- Parameters
clusterId (string) – Идентификатор кластера.
- Status Codes
200 OK – A successful response.
- Response JSON Object
task (object) – Информация о задаче.
task.createdAt (string) – Время создания задачи.
task.data (object) – Данные, если задача завершилась успешно.
task.data.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error (object) – Ошибка, если задача завершилась с ошибкой.
task.error.code (integer) – Код состояния.
task.error.details (array) – Список сообщений, содержащих сведения об ошибке.
task.error.details[].@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.error.message (string) – Сообщение об ошибке.
task.eventName (string) – Тип события.
task.id (string) – Идентификатор задачи.
task.metadata (object) – Данные, если задача завершилась успешно.
task.metadata.@type (string) – URL-адрес или имя ресурса, которое однозначно идентифицирует тип сериализованного сообщения буфера протокола.
task.status (string) – Статус задачи.
task.taskObjectId (string) – Идентификатор объекта задачи.
task.taskObjectType (string) – Тип объекта задачи.
task.updatedAt (string) – Время последнего обновления задачи.
task.userId (string) – Идентификатор пользователя.
Была ли статья полезной?
для Dev & Test