Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Managed Service for Elasticsearch
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Информация об имеющихся кластерах
    • Создание кластера
    • Подключение к кластеру
    • Остановка и запуск кластера
    • Управление хостами Elasticsearch
    • Управление пользователями Elasticsearch
    • Удаление кластера
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Индексы
    • Поиск с помощью Elasticsearch
    • Классы хостов
    • Сеть в Managed Service for Elasticsearch
    • Квоты и лимиты
    • Типы хранилища
    • Шардирование и репликация
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • ClusterService
      • OperationService
      • ResourcePresetService
      • UserService
      • OperationService
    • REST
      • Обзор
      • Cluster
        • Обзор
        • addHosts
        • create
        • delete
        • deleteHosts
        • get
        • list
        • listHosts
        • listLogs
        • listOperations
        • move
        • start
        • stop
        • streamLogs
        • update
      • Operation
        • Обзор
        • get
      • ResourcePreset
        • Обзор
        • get
        • list
      • User
        • Обзор
        • get
        • list
  • Вопросы и ответы
  1. Справочник API
  2. REST
  3. Cluster
  4. update

Метод update

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

Изменяет указанный кластер Elasticsearch.

HTTP-запрос

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

Path-параметры

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

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

{
  "updateMask": "string",
  "description": "string",
  "labels": "object",
  "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"
        }
      }
    }
  },
  "name": "string"
}
Поле Описание
updateMask string

Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре updateMask и в запросе не было отправлено значение для этого поля, значение поля будет сброшено на значение по умолчанию. Значение по умолчанию для большинства полей — null или 0.

Если в запросе не передается updateMask, значения всех полей будут обновлены. Для полей, указанных в запросе, будут использованы переданные значения. Значения остальных полей будут сброшены на значения по умолчанию.

description string

Новое описание кластера Elasticsearch.

Максимальная длина строки в символах — 256.

labels object

Пользовательские метки для кластера Elasticsearch в виде пар key:value.

Например, "project": "mvp" или "source": "dictionary".

Новый набор меток полностью заменит старый. Чтобы добавить метку, запросите текущий набор меток с помощью метода get, затем отправьте запрос update, добавив новую метку в этот набор.

Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*.

configSpec object

Новая конфигурация и ресурсы для хостов кластера Elasticsearch.

Используйте параметр updateMask чтобы предотвратить сброс настроек кластера, не перечисленных в config_spec, на значения по умолчанию.

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).

Эта настройка позволяет не допустить разрастания поисковых запросов до больших размеров, чтобы запросы не потребляли много памяти и ресурсов процессора. Настройка влияет не только на запросы типа bool, но и на многие другие запросы, которые неявно преобразуются Elasticsearch в запросы типа bool.

Значение по умолчанию: 1024.

См. подробное описание в документации 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

Тип хранилища для хоста. Все доступные типы перечислены в документации.

name string

Новое имя кластера Elasticsearch.

Максимальная длина строки в символах — 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.

В этой статье:
  • HTTP-запрос
  • Path-параметры
  • Параметры в теле запроса
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»