Node Pool

Подсказка

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

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

Метод API

HTTP-метод

Описание

Get

GET

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

Get {nodePoolId}

GET

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

Create

POST

Создает группу узлов в кластере OpenShift

Update

PATCH

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

Delete

DELETE

Удаляет группу узлов в кластере OpenShift

Пример запроса на создание группы узлов

{
  "serviceInstanceId": XXXX-XXXX-XXXX-XXXX,
  "clusterId": "XXXX-XXXX-XXXX-XXXX-XXXXXXXXX",
  "nodePoolName": "test-node",
  "nodeConfig": {
    "computeFlavor": "SMALL"
  },
  "scalePolicy": {
    "fixedScale": {
      "count": 2
    }
  }
}
GET /openshift/v1/{serviceInstanceId}/node-pools

Возвращает информацию о группах узлов

Parameters
  • serviceInstanceId (string) – идентификатор услуги (vDC)

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

Status Codes
  • 200 OK – A successful response

Response JSON Object
  • nodePools[].clusterId (string) – обязательное поле. Идентификатор кластера OpenShift, в котором будет создана группа узлов.

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

  • nodePools[].nodeConfig.computeFlavor (string) – обязательное поле. Характеристики типа ресурса, определяющего размеры оперативной памяти, дискового пространства, количества ядер и тому подобного, которые будет использоваться при создании узлов

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

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

POST /openshift/v1/{serviceInstanceId}/node-pools

Создаёт группу узлов для кластера OpenShift

Parameters
  • serviceInstanceId (string) – идентификатор услуги (vDC)

Request JSON Object
  • clusterId (string) – ID кластера, которому будет принадлежать группа узлов

  • nodeConfig.computeFlavor (string) – обязательное поле. Характеристики типа ресурса, определяющего размеры оперативной памяти, дискового пространства, количества ядер и тому подобного, которые будет использоваться при создании узлов

  • nodePoolName (string) – обязательное поле. Имя группы узлов

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

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • task.command (string) – тип задачи

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

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

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

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

  • task.error.details[].value (string) – значение ошибки

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

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

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

  • task.metadata.value (string) – значение ошибки

  • task.modifiedAt (string) – время последнего изменения ресурса

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

  • task.response.value (string) – значение ошибки

  • task.serviceInstanceId (string) – идентификатор vDC (услуги)

  • task.status (string) – статус выполнения задачи

GET /openshift/v1/{serviceInstanceId}/node-pools/{nodePoolId}

Возвращает информацию о группе узлов

Parameters
  • serviceInstanceId (string) – идентификатор услуги (vDC)

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

Status Codes
  • 200 OK – A successful response.

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

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

  • nodePool.nodeConfig.computeFlavor (string) – обязательное поле. Характеристики типа ресурса, определяющего размеры оперативной памяти, дискового пространства, количества ядер и тому подобного, которые будет использоваться при создании узлов

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

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

DELETE /openshift/v1/{serviceInstanceId}/node-pools/{nodePoolId}

Удаляет группу узлов из кластера OpenShift

Parameters
  • serviceInstanceId (string) – идентификатор услуги (vDC)

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

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • task.command (string) – тип задачи

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

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

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

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

  • task.error.details[].value (string) – значение ошибки

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

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

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

  • task.metadata.value (string) – значение ошибки

  • task.modifiedAt (string) – время последнего изменения ресурса

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

  • task.response.value (string) – значение ошибки

  • task.serviceInstanceId (string) – идентификатор vDC (услуги)

  • task.status (string) – статус выполнения задачи

PATCH /openshift/v1/{serviceInstanceId}/node-pools/{nodePoolId}

Обновляет существующую группу излов

Parameters
  • serviceInstanceId (string) – идентификатор услуги (vDC)

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

Request JSON Object
  • nodePoolName (string) – новое имя группы узлов

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

Status Codes
  • 200 OK – A successful response.

Response JSON Object
  • task.command (string) – тип задачи

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

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

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

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

  • task.error.details[].value (string) – значение ошибки

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

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

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

  • task.metadata.value (string) – значение ошибки

  • task.modifiedAt (string) – время последнего изменения ресурса

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

  • task.response.value (string) – значение ошибки

  • task.serviceInstanceId (string) – идентификатор vDC (услуги)

  • task.status (string) – статус выполнения задачи