Метод create

HTTP-запрос
Параметры в теле запроса
Ответ

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

HTTP-запрос

POST https://mks.api.cloud.yandex.net/managed-kubernetes/v1/clusters

Параметры в теле запроса

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "networkId": "string",
  "masterSpec": {
    "zonalMasterSpec": {
      "zoneId": "string",
      "internalV4AddressSpec": {
        "subnetId": "string"
      },
      "externalV4AddressSpec": {}
    }
  },
  "ipAllocationPolicy": {
    "clusterIpv4CidrBlock": "string",
    "serviceIpv4CidrBlock": "string"
  },
  "serviceAccountId": "string",
  "nodeServiceAccountId": "string",
  "gatewayIpv4Address": "string"
}

Поле	Описание
folderId	string Обязательное поле. Идентификатор каталога, в котором нужно создать кластер Kubernetes. Чтобы получить идентификатор каталога, используйте запрос list.
name	string Имя кластера Kubernetes. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`.
description	string Описание кластера Kubernetes. Максимальная длина строки в символах — 256.
labels	object Метки ресурса в формате `key:value`. Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению `[a-z][-_0-9a-z]`. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению `[-_0-9a-z]`.
networkId	string Обязательное поле. Идентификатор облачной сети.
masterSpec	object Обязательное поле. Политика распределения кластера Kubernetes.
masterSpec. zonalMasterSpec	object Спецификация зоны доступности мастера.
masterSpec. zonalMasterSpec. zoneId	string Обязательное поле. Идентификатор зоны доступности.
masterSpec. zonalMasterSpec. internalV4AddressSpec	object Спецификация параметров для внутренней IPv4 сети.
masterSpec. zonalMasterSpec. internalV4AddressSpec. subnetId	string Идентификатор подсети. Если идентификатор не указан, а в указанной зоне имеется только одна подсеть, адрес будет выделен в этой подсети.
masterSpec. zonalMasterSpec. externalV4AddressSpec	object Спецификация параметров для внешней IPv4 сети.
ipAllocationPolicy	object Политика распределения кластера Kubernetes.
ipAllocationPolicy. clusterIpv4CidrBlock	string CIDR. Диапазон IP-адресов для подов. Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes. Статические маршруты будут настроены для этих блоков CIDR в подсетях узлов.
ipAllocationPolicy. serviceIpv4CidrBlock	string CIDR. Диапазон IP-адресов для сервисов. Диапазон не должен пересекаться ни с одной подсетью в облачной сети, в которой находится кластер Kubernetes.
serviceAccountId	string Обязательное поле. Сервисный аккаунт, используемый для выделения Compute Cloud и VPC ресурсов для кластера Kubernetes. Выбранный сервисный аккаунт должна иметь `edit` роль в каталоге, в котором будет расположен кластер Kubernetes, и в каталоге, в котором находится выбранная сеть.
nodeServiceAccountId	string Обязательное поле. Сервисный аккаунт, используемый узлами кластера Kubernetes для доступа к Container Registry или для загрузки логов и метрик узла.
gatewayIpv4Address	string Адрес шлюза IPv4.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе Объект Operation.

Поле	Описание
id	string Идентификатор операции.
description	string Описание операции. Длина описания должна быть от 0 до 256 символов.
createdAt	string (date-time) Время создания ресурса в формате в RFC3339. Строка в формате RFC3339.
createdBy	string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modifiedAt	string (date-time) Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. Строка в формате RFC3339.
done	boolean (boolean) Если значение равно `false` — операция еще выполняется. Если `true` — операция завершена, и задано значение одного из полей `error` или `response`.
metadata	object Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля `metadata`.
error	object Описание ошибки в случае сбоя или отмены операции. включает только одно из полей `error`, `response` Описание ошибки в случае сбоя или отмены операции.
error. code	integer (int32) Код ошибки. Значение из списка google.rpc.Code.
error. message	string Текст ошибки.
error. details[]	object Список сообщений с подробными сведениями об ошибке.
response	object включает только одно из полей `error`, `response` Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля `response`.