Метод create
Создает новый кластер Elasticsearch в указанном каталоге.
HTTP-запрос
POST https://mdb.api.cloud.yandex.net/managed-elasticsearch/v1/clusters
Параметры в теле запроса
{
"folderId": "string",
"name": "string",
"description": "string",
"labels": "object",
"environment": "string",
"configSpec": {
"version": "string",
"elasticsearchSpec": {
"dataNode": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"elasticsearchConfig_7_6": {
"fielddataCacheSize": "integer",
"maxClauseCount": "integer"
}
},
"masterNode": {
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
}
}
}
},
"userSpecs": [
{
"name": "string",
"password": "string"
}
],
"hostSpecs": [
{
"zoneId": "string",
"subnetId": "string",
"assignPublicIp": true,
"type": "string",
"shardName": "string"
}
],
"networkId": "string"
}
Поле | Описание |
---|---|
folderId | string Обязательное поле. Идентификатор каталога, в котором будет создан кластер Elasticsearch. Максимальная длина строки в символах — 50. |
name | string Обязательное поле. Имя кластера Elasticsearch. Имя должно быть уникальным в рамках каталога. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению |
description | string Описание кластера Elasticsearch. Максимальная длина строки в символах — 256. |
labels | object Пользовательские метки для кластера Elasticsearch в виде пар Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению |
environment | string Среда развертывания кластера Elasticsearch.
|
configSpec | object Обязательное поле. Конфигурация Elasticsearch и хостов для кластера. |
configSpec. version |
string Версия Elasticsearch. |
configSpec. elasticsearchSpec |
object Конфигурация и распределение ресурсов для узлов Elasticsearch. |
configSpec. elasticsearchSpec. dataNode |
object Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Data node. |
configSpec. elasticsearchSpec. dataNode. resources |
object Ресурсы, выделенные узлам Elasticsearch с ролью Data node. |
configSpec. elasticsearchSpec. dataNode. resources. resourcePresetId |
string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т.д.). Все доступные наборы ресурсов перечислены в документации. |
configSpec. elasticsearchSpec. dataNode. resources. diskSize |
string (int64) Объем хранилища, доступного хосту, в байтах. |
configSpec. elasticsearchSpec. dataNode. resources. diskTypeId |
string Тип хранилища для хоста. Все доступные типы перечислены в документации. |
configSpec. elasticsearchSpec. dataNode. elasticsearchConfig_7_6 |
object Здесь перечислены поддерживаемые параметры конфигурации Elasticsearch 7.6. Подробное описание всех параметров доступно в документации Elasticsearch. Любые параметры, не перечисленные здесь, не поддерживаются. |
configSpec. elasticsearchSpec. dataNode. elasticsearchConfig_7_6. fielddataCacheSize |
integer (int64) Максимальный процент от общего объема кучи (heap), который может выделяться под кэш данных в полях. Все значения полей, помещенные в этот кэш, загружаются в память для обеспечения быстрого доступа к этим значениям при работе с документами. Построение кэша данных для поля — затратная операция, поэтому рекомендуется иметь достаточный объем памяти для этого кэша и поддерживать его в заполненном состоянии. Значение по умолчанию: не ограничено. См. подробное описание в документации Elasticsearch. |
configSpec. elasticsearchSpec. dataNode. elasticsearchConfig_7_6. maxClauseCount |
integer (int64) Максимальное число выражений, которое может содержаться в булевом запросе (bool query). Эта настройка позволяет не допустить разрастания поисковых запросов до больших размеров, чтобы запросы не потребляли много памяти и ресурсов процессора. Настройка влияет не только на запросы типа Значение по умолчанию: См. подробное описание в документации Elasticsearch. |
configSpec. elasticsearchSpec. masterNode |
object Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Master node. |
configSpec. elasticsearchSpec. masterNode. resources |
object Ресурсы, выделенные узлам Elasticsearch с ролью Master node. |
configSpec. elasticsearchSpec. masterNode. resources. resourcePresetId |
string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т.д.). Все доступные наборы ресурсов перечислены в документации. |
configSpec. elasticsearchSpec. masterNode. resources. diskSize |
string (int64) Объем хранилища, доступного хосту, в байтах. |
configSpec. elasticsearchSpec. masterNode. resources. diskTypeId |
string Тип хранилища для хоста. Все доступные типы перечислены в документации. |
userSpecs[] | object Обязательное поле. Одно или несколько описаний пользователей, которых нужно создать в кластере Elasticsearch. Должен содержать хотя бы один элемент. |
userSpecs[]. name |
string Обязательное поле. Имя пользователя Elasticsearch. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению |
userSpecs[]. password |
string Обязательное поле. Пароль пользователя Elasticsearch. Длина строки в символах должна быть от 8 до 128. |
hostSpecs[] | object Обязательное поле. Одна или несколько конфигураций хостов, создаваемых в кластере Elasticsearch. Должен содержать хотя бы один элемент. |
hostSpecs[]. zoneId |
string Идентификатор зоны доступности, в которой находится хост. Максимальная длина строки в символах — 50. |
hostSpecs[]. subnetId |
string Идентификатор подсети, в которой находится хост. Максимальная длина строки в символах — 50. |
hostSpecs[]. assignPublicIp |
boolean (boolean) Флаг, определяющий, назначен ли хосту публичный IP-адрес. Если значение равно |
hostSpecs[]. type |
string Обязательное поле. Тип хоста.
|
hostSpecs[]. shardName |
string Имя шарда, который нужно создать на хосте. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению |
networkId | string Обязательное поле. Идентификатор сети, в которой будет создан кластер Elasticsearch. Максимальная длина строки в символах — 50. |
Ответ
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) Если значение равно |
metadata | object Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля |
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, в описании метода приведена структура соответствующего ему поля |