Группа узлов

В разделе описаны методы для управления группой узлов.

POST /v2/clusters/{clusterId}/node-pools

Создание новой группы узлов.

Parameters

  • clusterId (string) – Идентификатор кластера, в котором будет создана группа узлов.

Request JSON Object

  • displayName (string) – Название группы узлов. Должно быть уникальным. Может содержать буквы, цифры, подчеркивание и дефисы. Допустимое количество символов от 4 до 60.

  • hardwareCompute (object) – Описание инфраструктуры узлов группы.

  • hardwareCompute.diskSize (integer) – Размер подключаемого диска в ГБ.

  • hardwareCompute.diskType (string) – Тип диска.

  • hardwareCompute.flavor (object) – Шаблон конфигурации для ВМ.

  • hardwareCompute.flavor.cpu (integer) – Количество ядер процессора виртуальной машины.

  • hardwareCompute.flavor.flavorId (string) – Идентификатор шаблона конфигурации.

  • hardwareCompute.flavor.name (string) – Название шаблона конфигурации.

  • hardwareCompute.flavor.ram (integer) – Оперативная память виртуальной машины в ГБ.

  • labels (object) – Набор меток (labels), которые будут применены к узлам в группе. Метки добавляются в дополнение к стандартным меткам, которые может применить Kubernetes. В случае конфликтов поведение неопределенно и может меняться в зависимости от версии Kubernetes, поэтому лучше избегать таких конфликтов. Подробнее см. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/.

  • machineConfiguration (object) – Параметры конфигурации виртуальной машины.

  • machineConfiguration.diskSize (integer) – Размер подключаемого диска в ГБ. Минимальный размер диска - 10 ГБ. Если не указан, то размер диска по умолчанию для кластера - 10 ГБ.

  • machineConfiguration.diskType (string) – Тип диска.

  • machineConfiguration.flavorId (string) – Идентификатор шаблона конфигурации.

  • networkConfiguration (object) – Конфигурация сети группы узлов.

  • networkConfiguration.nodesSubnetCidr (string) – Адрес сети узлов в формате RFC1918. Если указать это значение, то сеть будет создана автоматически.

  • networkConfiguration.nodesSubnetId (string) – Идентификатор существующей сети узлов.

  • networkConfiguration.securityGroupId (string) – Идентификатор группы безопасности. Опциональное поле.

  • scalePolicy (object) – Политика масштабирования группы узлов.

  • scalePolicy.autoScale (object) – Автоматически масштабируемое число узлов.

  • scalePolicy.autoScale.initialCount (integer) – Начальное количество узлов. Обязателен при создании группы узлов. При редактировании группы узлов является опциональным.

  • scalePolicy.autoScale.maxCount (integer) – Максимальное количество узлов в группе узлов.

  • scalePolicy.autoScale.minCount (integer) – Минимальное количество узлов в группе узлов.

  • scalePolicy.fixedScale (object) – Фиксированное число узлов.

  • scalePolicy.fixedScale.count (integer) – Количество узлов в группе.

  • taints (array) – Список ограничений (taints), применяемых к узлам в группе. Подробнее см. https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/.

  • taints[].effect (string) – Применяемый эффект.

  • taints[].key (string) – Ключ.

  • taints[].value (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/node-pools

Получение списка групп узлов.

Query Parameters

  • clusterId (string) – Идентификатор кластера.

  • limit (integer) – Количество групп узлов в ответе.

  • offset (integer) – Количество пропущенных групп узлов.

  • sort (string) – Параметры сортировки списка кластеров. Имеют вид «field direction». Возможные значения для field: displayName, nodeCount, cpu, ram, disk, createdAt. Возможные значения для direction: asc, desc.

  • filters (array) – Параметры фильтрации списка групп узлов. Имеют вид «field condition value» или «field:value»(include). Возможные значения для field: displayName, state, nodeCount, cpu, ram, disk, createdAt. Возможные значения для condition: =, !=, >, >=, <, <=.

Status Codes

  • 200 OK – A successful response.

Response JSON Object

  • items (array) – Список групп узлов.

  • items[].clusterId (string) – Идентификатор кластера, в котором развернута группа узлов.

  • items[].createdAt (string) – Время создания группы узлов.

  • items[].createdBy (string) – Идентификатор пользователя, создавшего группу узлов.

  • items[].displayName (string) – Название группы узлов.

  • items[].hardwareCompute (object) – Описание инфраструктуры узлов группы.

  • items[].hardwareCompute.diskSize (integer) – Размер подключаемого диска в ГБ.

  • items[].hardwareCompute.diskType (string) – Тип диска.

  • items[].hardwareCompute.flavor (object) – Шаблон конфигурации для ВМ.

  • items[].hardwareCompute.flavor.cpu (integer) – Количество ядер процессора виртуальной машины.

  • items[].hardwareCompute.flavor.flavorId (string) – Идентификатор шаблона конфигурации.

  • items[].hardwareCompute.flavor.name (string) – Название шаблона конфигурации.

  • items[].hardwareCompute.flavor.ram (integer) – Оперативная память виртуальной машины в ГБ.

  • items[].labels (object) – Набор меток (labels), применяемых к узлам в группе.

  • items[].nodePoolId (string) – Идентификатор группы узлов.

  • items[].nodesDesired (integer) – Запрашиваемое количество узлов.

  • items[].nodesNetworkConfiguration (object) – Конфигурация сети нод.

  • items[].nodesNetworkConfiguration.nodesSubnetCidr (string) – Адрес сети узлов группы.

  • items[].nodesNetworkConfiguration.nodesSubnetId (string) – Идентификатор сети узлов группы.

  • items[].nodesNetworkConfiguration.securityGroupId (string) – Идентификатор группы безопасности. Опциональное поле.

  • items[].nodesReady (integer) – Количество готовых к работе узлов.

  • items[].scalePolicy (object) – Политика масштабирования группы узлов.

  • items[].scalePolicy.autoScale (object) – Автоматически масштабируемое число узлов.

  • items[].scalePolicy.autoScale.initialCount (integer) – Начальное количество узлов. Обязателен при создании группы узлов. При редактировании группы узлов является опциональным.

  • items[].scalePolicy.autoScale.maxCount (integer) – Максимальное количество узлов в группе узлов.

  • items[].scalePolicy.autoScale.minCount (integer) – Минимальное количество узлов в группе узлов.

  • items[].scalePolicy.fixedScale (object) – Фиксированное число узлов.

  • items[].scalePolicy.fixedScale.count (integer) – Количество узлов в группе.

  • items[].state (string) – Состояние узла.

  • items[].taints (array) – Список ограничений (taints), применяемых к узлам в группе.

  • items[].taints[].effect (string) – Применяемый эффект.

  • items[].taints[].key (string) – Ключ.

  • items[].taints[].value (string) – Значение.

  • items[].updatedAt (string) – Время последнего обновления группы узлов.

  • items[].updatedBy (string) – Идентификатор пользователя, обновившего группу узлов.

  • items[].version (string) – Версия Kubernetes, которая используется на узлах группы.

  • limit (integer) – Количество групп узлов в ответе.

  • offset (integer) – Количество пропущенных групп узлов.

  • total (integer) – Общее число групп узлов.

GET /v2/node-pools/{nodePoolId}/nodes

Получение списка узлов.

Parameters

  • nodePoolId (string) – Идентификатор группы узлов.

Query Parameters

  • limit (integer) – Количество узлов в ответе.

  • offset (integer) – Количество пропущенных узлов.

  • filters (array) – Параметры фильтрации списка узлов в виде «field condition value» или «field:value»(include). Возможные значения для field: state, hostname, ipaddress, vmname. Возможные значения для condition: =, :.

  • sort (string) – Параметры сортировки списка узлов. Имеют вид «field direction». Возможные значения для field: createdAt, updatedAt, vmname, hostname. Возможные значения для direction: asc, desc.

Status Codes

  • 200 OK – A successful response.

Response JSON Object

  • limit (integer) – Количество групп в ответе.

  • nodes (array) – Список узлов в группе и информация по ним.

  • nodes[].createdAt (string) – Время создания узла.

  • nodes[].hostname (string) – Название узла.

  • nodes[].id (string) – Идентификатор узла.

  • nodes[].ipAddress (string) – IP-адрес узла.

  • nodes[].state (string) – Состояние узла.

  • nodes[].updateAt (string) – Время обновления узла.

  • nodes[].vmName (string) – Название виртуальной машины.

  • offset (integer) – Количество пропущенных узлов.

  • total (integer) – Общее число узлов.

GET /v2/node-pools/{nodePoolId}

Получение информации по конкретной группе узлов.

Parameters

  • nodePoolId (string) – Идентификатор группы узлов.

Status Codes

  • 200 OK – A successful response.

Response JSON Object

  • nodePool (object) – Информация по запрашиваемой группе узлов.

  • nodePool.clusterId (string) – Идентификатор кластера, в котором развернута группа узлов.

  • nodePool.createdAt (string) – Время создания группы узлов.

  • nodePool.createdBy (string) – Идентификатор пользователя, создавшего группу узлов.

  • nodePool.displayName (string) – Название группы узлов.

  • nodePool.hardwareCompute (object) – Описание инфраструктуры узлов группы.

  • nodePool.hardwareCompute.diskSize (integer) – Размер подключаемого диска в ГБ.

  • nodePool.hardwareCompute.diskType (string) – Тип диска.

  • nodePool.hardwareCompute.flavor (object) – Шаблон конфигурации для ВМ.

  • nodePool.hardwareCompute.flavor.cpu (integer) – Количество ядер процессора виртуальной машины.

  • nodePool.hardwareCompute.flavor.flavorId (string) – Идентификатор шаблона конфигурации.

  • nodePool.hardwareCompute.flavor.name (string) – Название шаблона конфигурации.

  • nodePool.hardwareCompute.flavor.ram (integer) – Оперативная память виртуальной машины в ГБ.

  • nodePool.labels (object) – Набор меток (labels), применяемых к узлам в группе.

  • nodePool.nodePoolId (string) – Идентификатор группы узлов.

  • nodePool.nodesDesired (integer) – Запрашиваемое количество узлов.

  • nodePool.nodesNetworkConfiguration (object) – Конфигурация сети нод.

  • nodePool.nodesNetworkConfiguration.nodesSubnetCidr (string) – Адрес сети узлов группы.

  • nodePool.nodesNetworkConfiguration.nodesSubnetId (string) – Идентификатор сети узлов группы.

  • nodePool.nodesNetworkConfiguration.securityGroupId (string) – Идентификатор группы безопасности. Опциональное поле.

  • nodePool.nodesReady (integer) – Количество готовых к работе узлов.

  • nodePool.scalePolicy (object) – Политика масштабирования группы узлов.

  • nodePool.scalePolicy.autoScale (object) – Автоматически масштабируемое число узлов.

  • nodePool.scalePolicy.autoScale.initialCount (integer) – Начальное количество узлов. Обязателен при создании группы узлов. При редактировании группы узлов является опциональным.

  • nodePool.scalePolicy.autoScale.maxCount (integer) – Максимальное количество узлов в группе узлов.

  • nodePool.scalePolicy.autoScale.minCount (integer) – Минимальное количество узлов в группе узлов.

  • nodePool.scalePolicy.fixedScale (object) – Фиксированное число узлов.

  • nodePool.scalePolicy.fixedScale.count (integer) – Количество узлов в группе.

  • nodePool.state (string) – Состояние узла.

  • nodePool.taints (array) – Список ограничений (taints), применяемых к узлам в группе.

  • nodePool.taints[].effect (string) – Применяемый эффект.

  • nodePool.taints[].key (string) – Ключ.

  • nodePool.taints[].value (string) – Значение.

  • nodePool.updatedAt (string) – Время последнего обновления группы узлов.

  • nodePool.updatedBy (string) – Идентификатор пользователя, обновившего группу узлов.

  • nodePool.version (string) – Версия Kubernetes, которая используется на узлах группы.

DELETE /v2/node-pools/{nodePoolId}

Удаление группы узлов.

Parameters

  • nodePoolId (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/node-pools/{nodePoolId}

Редактирование группы узлов.

Parameters

  • nodePoolId (string) – Идентификатор группы узлов.

Request JSON Object

  • data (object) – Информацию о группе узлов, которую необходимо изменить.

  • data.displayName (string) – Название группы узлов.

  • data.scalePolicy (object) – Политика масштабирования группы узлов.

  • data.scalePolicy.autoScale (object) – Автоматически масштабируемое число узлов.

  • data.scalePolicy.autoScale.initialCount (integer) – Начальное количество узлов. Обязателен при создании группы узлов. При редактировании группы узлов является опциональным.

  • data.scalePolicy.autoScale.maxCount (integer) – Максимальное количество узлов в группе узлов.

  • data.scalePolicy.autoScale.minCount (integer) – Минимальное количество узлов в группе узлов.

  • data.scalePolicy.fixedScale (object) – Фиксированное число узлов.

  • data.scalePolicy.fixedScale.count (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) – Идентификатор пользователя.

Запустили Evolution free tier
для Dev & Test
Получить