Управление кластером Kubernetes
Набор методов для управления кластером Kubernetes.
Возвращает список всех кластеров.
Запрос
GET /kubernetes/v1/clusters
Статус запроса
200 OK
– запрос выполнен успешно.Ответ
Параметр | Тип | Описание |
---|---|---|
clusters[].clusterId | string | Уникальный идентификатор кластера |
clusters[].clusterName | string | Уникальное имя кластера |
clusters[].projectId | string | Идентификатор проекта, в котором кластер был создан |
clusters[].regionId | string | Идентификатор региона, в котором кластер был создан |
Создает новый кластер Kubernetes.
Запрос
POST /kubernetes/v1/clusters
Ответ
Параметр | Тип | Описание |
---|---|---|
addonsConfig.dashboard.enabled | boolean | Активация панели управления |
clusterName | string | Обязательное поле. Имя должно быть уникальным. Может содержать строчные буквы латинского алфавита, цифры и дефисы. Допустимое количество символов от 3 до 20 |
projectId | string | Идентификатор проекта, в котором будет создан кластер. Если значение не указано, кластер будет создан в проекте по умолчанию |
regionId | string | Идентификатор региона, в котором будет создан кластер Kubernetes. Если значение не указано, кластер будет создан в регионе по умолчанию |
Статус запроса
200 OK
– запрос выполнен успешно.Ответ
Параметр | Тип | Описание |
---|---|---|
command | string | Команда на выполнение (например, создать кластер, удалить кластер) |
createdAt | string | Время создания задачи |
error.code | integer | Код статуса, является значением перечисления [google.rpc.Code] |
error.details[].typeUrl | string | URL-адрес/имя ресурса, идентифицирующее тип сообщения сериализованного протокольного буфера |
error.details[].value | string | Допустимый сериализованный буфер протокола указанного выше типа |
error.message | string | Сообщение об ошибке для разработчиков (на английском языке). Любое сообщение об ошибке локализуется и отправляется в поле [google.rpc.Status.details] |
id | string | Уникальный идентификатор задачи |
metadata.typeUrl | string | URL-адрес/имя ресурса, идентифицирующее тип сообщения сериализованного протокольного буфера |
metadata.value | string | Допустимый сериализованный буфер протокола указанного выше типа |
response.typeUrl | string | URL-адрес/имя ресурса, идентифицирующее тип сообщения сериализованного протокольного буфера |
response.value | string | Допустимый сериализованный буфер протокола указанного выше типа |
status | string | Статус выполнения задачи |
statusChangedAt | string | Последнее время изменения статуса задачи |
Удаляет кластер Kubernetes по указанному идентификатору.
Запрос
DELETE /kubernetes/v1/clusters/{clusterId}
Параметры:
Параметр | Тип | Описание |
---|---|---|
clusterId | string | Уникальный идентификатор кластера |
Статус запроса
200 OK
– запрос выполнен успешно.Ответ
Параметр | Тип | Описание |
---|---|---|
command | string | Команда на выполнение (например, создать кластер, удалить кластер) |
createdAt | string | Время создания задачи |
error.code | integer | Код статуса, который должен быть значением перечисления [google.rpc.Code] |
error.details[].typeUrl | string | URL-адрес/имя ресурса, идентифицирующее тип сообщения сериализованного протокольного буфера |
error.details[].value | string | Допустимый сериализованный буфер протокола указанного выше типа |
error.message | string | Сообщение об ошибке для разработчиков (на английском языке). Любое сообщение об ошибке локализуется и отправляется в поле [google.rpc.Status.details] |
id | string | Уникальный идентификатор задачи |
metadata.typeUrl | string | URL-адрес/имя ресурса, идентифицирующее тип сообщения сериализованного протокольного буфера |
metadata.value | string | Допустимый сериализованный буфер протокола указанного выше типа |
response.typeUrl | string | URL-адрес/имя ресурса, идентифицирующее тип сообщения сериализованного протокольного буфера |
response.value | string | Допустимый сериализованный буфер протокола указанного выше типа |
status | string | Статус выполнения задачи |
statusChangedAt | string | Последнее время изменения статуса задачи |