/ DOCS
Облако VMware
Тема интерфейса

Node Pool

Подсказка

Актуальную спецификацию можно скачать и использовать в привычном инструменте.

Набор методов для управления группой узлов Kubernetes:

Метод API

HTTP-метод

Описание

Get

GET

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

Get {nodePoolId}

GET

Возвращает данные по указанной группе узлов Kubernetes

Create

POST

Создает группу узлов в указанном кластере Kubernetes

Update

PATCH

Изменяет характеристики группы узлов Kubernetes

Delete

DELETE

Удаляет группу узлов Kubernetes

Query Parameters

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

Status Codes

  • 200 OK – A successful response.

Response JSON Object

  • nodePools (array) – параметры группы узлов

  • nodePools[].availableReplicas (integer) – количество доступных реплик в группе узлов

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

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

  • nodePools[].id (string) – идентификатор группы узлов, развернутых в кластере

  • nodePools[].name (string) – имя группы узлов

  • nodePools[].nodes (array) – параметры узела

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

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

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

  • nodePools[].nodes[].name (string) – имя узла

  • nodePools[].nodes[].phase (string) – фаза развертывания узла

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

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

  • nodePools[].scalePolicy.autoScale.initialCount (integer) – начальное количество узлов

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

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

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

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

  • nodePools[].taints (array) – объект Kubernetes, подробнее в документации Kubernetes

  • nodePools[].taints[].effect (string) – объект Kubernetes, подробнее в документации Kubernetes

  • nodePools[].taints[].key (string) – объект Kubernetes, подробнее в документации Kubernetes

  • nodePools[].taints[].value (string) – объект Kubernetes, подробнее в документации Kubernetes

  • nodePools[].version (string) – версия Kubernetes в группе узлов

Request JSON Object

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

  • hardwareCompute (object) – обязательное поле. Количество ресурсов, выделенных для группы узлов

  • hardwareCompute.cpu (integer) – обязательное поле. Количество vCPU, выделенных для группы узлов

  • hardwareCompute.ram (integer) – обязательное поле. Количество RAM в МБ

  • name (string) – обязательное поле. Имя должно быть уникальным. Может содержать строчные буквы латинского алфавита, цифры и дефисы. Допустимое количество символов от 3 до 20

  • 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) – объект Kubernetes, подробнее в документации Kubernetes

  • taints[].effect (string) – объект Kubernetes, подробнее в документации Kubernetes

  • taints[].key (string) – объект Kubernetes, подробнее в документации Kubernetes

  • taints[].value (string) – объект Kubernetes, подробнее в документации Kubernetes

Status Codes

  • 200 OK – A successful response

Response JSON Object

  • command (string) – команда на выполнениe (создать кластер, удалить кластер и т.п)

  • createdAt (string) – время создания задачи

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

  • done (boolean) – статус выполнения запроса. Если значение равно false — операция еще выполняется. Если поле false и поле error не пустое — задача завершилась с ошибкой. Если true — операция завершена успешно

  • doneAt (string) – время завершения выполнения задачи

  • error (object) – сообщение об ошибке

  • error.code (integer) – код ошибки. Доступные коды ошибок определены в google.rpc.Code

  • error.details (array) – дополнительные сведения об ошибке о типе протокола передачи данных. Соответствия gRPC-статусов с HTTP-кодами определены в google.rpc.Code

  • error.details[].@type (string) – дополнительные сведения об ошибке о типе протокола передачи данных. Соответствия gRPC-статусов с HTTP-кодами описаны в google.rpc.Code

  • error.message (string) – описание ошибки

  • id (string) – идентификатор задачи (task)

  • metadata (object) – метаданные задачи. Обычно в поле содержится идентификатор ресурса, над которым выполняется задача

Parameters

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

Status Codes

  • 200 OK – A successful response

Response JSON Object

  • availableReplicas (integer) – количество доступных реплик в группе узлов

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

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

  • id (string) – идентификатор группы узлов, развернутых в кластере

  • name (string) – имя группы узлов

  • nodes (array) – параметры узела

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

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

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

  • nodes[].name (string) – имя узла

  • nodes[].phase (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) – объект Kubernetes, подробнее в документации Kubernetes

  • taints[].effect (string) – объект Kubernetes, подробнее в документации Kubernetes

  • taints[].key (string) – объект Kubernetes, подробнее в документации Kubernetes

  • taints[].value (string) – объект Kubernetes, подробнее в документации Kubernetes

  • version (string) – версия Kubernetes в группе узлов

Parameters

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

Status Codes

  • 200 OK – A successful response

Response JSON Object

  • command (string) – команда на выполнениe (создать кластер, удалить кластер и т.п)

  • createdAt (string) – время создания задачи

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

  • done (boolean) – статус выполнения запроса. Если значение равно false — операция еще выполняется. Если поле false и поле error не пустое — задача завершилась с ошибкой. Если true — операция завершена успешно

  • doneAt (string) – время завершения выполнения задачи

  • error (object) – сообщение об ошибке

  • error.code (integer) – код ошибки. Доступные коды ошибок определены в google.rpc.Code

  • error.details (array) – дополнительные сведения об ошибке о типе протокола передачи данных. Соответствия gRPC-статусов с HTTP-кодами определены в google.rpc.Code

  • error.details[].@type (string) – дополнительные сведения об ошибке о типе протокола передачи данных. Соответствия gRPC-статусов с HTTP-кодами описаны в google.rpc.Code

  • error.message (string) – описание ошибки

  • id (string) – идентификатор задачи (task)

  • metadata (object) – метаданные задачи. Обычно в поле содержится идентификатор ресурса, над которым выполняется задача

PATCH /kubernetes/v1/nodePools/{nodePoolId}
Parameters

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

Request JSON Object

  • name (string) – имя должно быть уникальным. Может содержать строчные буквы латинского алфавита, цифры и дефисы. Допустимое количество символов от 3 до 20

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

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

  • scalePolicy.autoScale.initialCount (integer) – начальное количество узлов

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

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

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

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

Status Codes

  • 200 OK – A successful response

Response JSON Object

  • command (string) – команда на выполнениe (создать кластер, удалить кластер и т.п)

  • createdAt (string) – время создания задачи

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

  • done (boolean) – статус выполнения запроса. Если значение равно false — операция еще выполняется. Если поле false и поле error не пустое — задача завершилась с ошибкой. Если true — операция завершена успешно

  • doneAt (string) – время завершения выполнения задачи

  • error (object) – сообщение об ошибке

  • error.code (integer) – код ошибки. Доступные коды ошибок определены в google.rpc.Code

  • error.details (array) – дополнительные сведения об ошибке о типе протокола передачи данных. Соответствия gRPC-статусов с HTTP-кодами определены в google.rpc.Code

  • error.details[].@type (string) – дополнительные сведения об ошибке о типе протокола передачи данных. Соответствия gRPC-статусов с HTTP-кодами описаны в google.rpc.Code

  • error.message (string) – описание ошибки

  • id (string) – идентификатор задачи (task)

  • metadata (object) – метаданные задачи. Обычно в поле содержится идентификатор ресурса, над которым выполняется задача

Предыдущая статья
Cluster
Следующая статья
Task
Была ли эта статья полезна?
Поддержка Юридические документы
© 2025 Cloud.ru