Подключиться
Yandex Managed Service for Elasticsearch

Метод addHosts

Добавляет новые хосты в указанный кластер Elasticsearch.

HTTP-запрос

POST https://mdb.api.cloud.yandex.net/managed-elasticsearch/v1/clusters/{clusterId}/hosts:batchCreate

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера Elasticsearch. Чтобы получить идентификатор кластера Elasticsearch, выполните запрос list. Максимальная длина строки в символах — 50.

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

{
  "hostSpecs": [
    {
      "zoneId": "string",
      "subnetId": "string",
      "assignPublicIp": true,
      "type": "string",
      "shardName": "string"
    }
  ]
}
Поле Описание
hostSpecs[] object

Обязательное поле. Одна или несколько конфигураций хостов, добавляемых в кластер Elasticsearch.

Должен содержать хотя бы один элемент.
hostSpecs[].
zoneId		 string

Идентификатор зоны доступности, в которой находится хост.

Максимальная длина строки в символах — 50.
hostSpecs[].
subnetId		 string

Идентификатор подсети, в которой находится хост.

Максимальная длина строки в символах — 50.
hostSpecs[].
assignPublicIp		 boolean (boolean)

Флаг, определяющий, назначен ли хосту публичный IP-адрес.

Если значение равно true, то этот хост доступен в Интернете через его публичный IP-адрес.
hostSpecs[].
type		 string

Обязательное поле. Тип хоста.

  • DATA_NODE: этот хост является узлом Elasticsearch с ролью Data node.
  • MASTER_NODE: этот хост является узлом Elasticsearch с ролью Master node.
hostSpecs[].
shardName		 string

Имя шарда, который нужно создать на хосте.

Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

Ответ

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.
В этой статье: