Cluster

Подсказка

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

Набор методов для управления кластером Опеншифт:

Метод API

HTTP-метод

Описание

Create

POST

Создает кластер Опеншифт

Delete

DELETE

Удаляет кластер Опеншифт

Get {serviceInstanceId}/clusters

GET

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

Get {serviceInstanceId}/clusters/{clusterId}

GET

Возвращает информацию о конкретном кластере

Пример запроса на создание кластера

{
  "clusterName": test-name,
  "openshiftVersion": 4.9.23,
  "ipv4Policy": {
    "serviceCidrBlock": 10.0.0.0/8,
    "clusterNetworkCidrBlock": 172.16.0.0./12
}
GET /openshift/v1/{serviceInstanceId}/clusters

Возвращает информацию о кластерах

Parameters

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

Status Codes

  • 200 OK – A successful response

Response JSON Object

  • clusters (array) –

  • clusters[].consoleUrl (string) – URL консоли управления OpenShift

  • clusters[].coresUsed (integer) – используемые кластером vCPU (ядра)

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

  • clusters[].healthy (boolean) – состояние кластера

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

  • clusters[].name (string) – имя кластера

  • clusters[].ramUsed (integer) – используемая кластером оперативная память (ГБ)

  • clusters[].storageUsed (integer) – используемое кластером дисковое пространство (ГБ)

  • clusters[].version (string) – версия OpenShift

  • clusters[].workersCount (integer) – количество воркеров в кластере

POST /openshift/v1/{serviceInstanceId}/clusters

Создаёт кластер OpenShift

Parameters

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

Request JSON Object

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

  • ipv4Policy (object) –

  • ipv4Policy.clusterNetworkCidrBlock (string) – подсеть IP-адресов, из которой для каждой ноды будет выделяться подсеть (/23) IP-адресов подов. Пример: 10.128.0.0/14 Минимальный размер подсети: /16. Рекомендуемый: /14. Должна принадлежать приватным диапазонам (RFC 1918): 10.0.0.0/8, 172.16.0.0/12. Недопустимо пересечение с подсетью/подсетями в вашей облачной инфраструктуре. Недопустимо пересечение с serviceNetwork. Недопустимо пересечение с зарезервированными служебными подсетями: 172.17.0.0/16, 10.0.0.0/16, 192.168.0.0/24

  • ipv4Policy.serviceCidrBlock (string) – подсеть IP-адресов для сервисов. Пример: 172.30.0.0/16 Минимальный размер подсети: /16. Должна принадлежать приватным диапазонам (RFC 1918): 10.0.0.0/8, 172.16.0.0/12. Недопустимо пересечение с подсетью/подсетями в облачной сети, в которой находится кластер OpenShift. Недопустимо пересечение с clusterNetwork. Недопустимо пересечение с зарезервированными служебными подсетями: 172.17.0.0/16, 10.0.0.0/16, 192.168.0.0/24

  • openshiftVersion (string) – версия OpenShift

Status Codes

  • 200 OK – A successful response

Response JSON Object

  • task (object) –

  • task.command (string) – тип задачи (создать кластер, удалить кластер и т.д)

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

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

  • task.error (object) – необязательное поле. Описание ошибки (если имеется)

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

  • task.error.details (array) – A list of messages that carry the error details. There is a common set of message types for APIs to use.

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

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

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

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

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

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

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

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

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

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

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

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

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

GET /openshift/v1/{serviceInstanceId}/clusters/{clusterId}

Возвращает информацию о кластере

Parameters

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

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

Status Codes

  • 200 OK – A successful response

Response JSON Object

  • cluster (object) –

  • cluster.consoleUrl (string) – URL консоли управления OpenShift

  • cluster.coresUsed (integer) – используемые кластером vCPU (ядра)

  • cluster.createdAt (string) – время создания кластера

  • cluster.healthy (boolean) – состояние кластера

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

  • cluster.name (string) – имя кластера

  • cluster.ramUsed (integer) – используемая кластером оперативная память (ГБ)

  • cluster.storageUsed (integer) – используемое кластером дисковое пространство (ГБ)

  • cluster.version (string) – версия OpenShift

  • cluster.workersCount (integer) – количество воркеров в кластере

DELETE /openshift/v1/{serviceInstanceId}/clusters/{clusterId}

Удаляет кластер OpenShift

Parameters

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

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

Status Codes

  • 200 OK – A successful response

Response JSON Object

  • task (object) –

  • task.command (string) – тип задачи (создать кластер, удалить кластер и т.д)

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

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

  • task.error (object) – необязательное поле. Описание ошибки (если имеется)

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

  • task.error.details (array) – A list of messages that carry the error details. There is a common set of message types for APIs to use.

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

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

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

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

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

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

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

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

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

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

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

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

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