Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Руководство [8.17] ›REST API ›API автомасштабирования

API создания или обновления политики автомасштабирования

Эта функция предназначена для косвенного использования Elasticsearch Service, Elastic Cloud Enterprise и Elastic Cloud on Kubernetes. Прямое использование не поддерживается.

Новая справка по API

Для получения самых свежих данных об API обратитесь к API автомасштабирования.

Создает или обновляет политику автомасштабирования.

Запрос

resp = client.autoscaling.put_autoscaling_policy(
    name="<name>",
    policy={
        "roles": [],
        "deciders": {
            "fixed": {}
        }
    },
)
print(resp)
const response = await client.autoscaling.putAutoscalingPolicy({
  name: "<name>",
  policy: {
    roles: [],
    deciders: {
      fixed: {},
    },
  },
});
console.log(response);
PUT /_autoscaling/policy/<name>
{
  "roles": [],
  "deciders": {
    "fixed": {
    }
  }
}

Предварительные требования

  • Если функции безопасности Elasticsearch включены, необходимо иметь право manage_autoscaling cluster для использования этого API.
  • Если функция прав оператора активна, использовать этот API могут только пользователи-операторы.

Описание

Этот API устанавливает политику автомасштабирования с указанным именем. См. страничку Автомасштабирования Deciders для доступных стратегий.

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

master_timeout
(Необязательно, единицы измерения времени) Время ожидания мастера. Если мастер недоступен до истечения таймаута, запрос завершается ошибкой. По умолчанию 30s. Также можно установить -1, чтобы запрос не имел таймаута.
timeout
(Необязательно, единицы измерения времени) Время ожидания ответа от всех соответствующих узлов кластера после обновления метаданных. Если ответ не получен до истечения таймаута, обновление метаданных кластера всё равно произойдёт, но ответ укажет, что он не был полностью подтверждён. По умолчанию 30s. Также можно установить -1, чтобы запрос не имел таймаута.

Примеры

В этом примере устанавливается политика автомасштабирования с именем my_autoscaling_policy, использующая стратегию fixed, которая применяется к узлам с ролью (только) "data_hot".

resp = client.autoscaling.put_autoscaling_policy(
    name="my_autoscaling_policy",
    policy={
        "roles": [
            "data_hot"
        ],
        "deciders": {
            "fixed": {}
        }
    },
)
print(resp)
const response = await client.autoscaling.putAutoscalingPolicy({
  name: "my_autoscaling_policy",
  policy: {
    roles: ["data_hot"],
    deciders: {
      fixed: {},
    },
  },
});
console.log(response);
PUT /_autoscaling/policy/my_autoscaling_policy
{
  "roles" : [ "data_hot" ],
  "deciders": {
    "fixed": {
    }
  }
}

API возвращает следующий результат:

{
  "acknowledged": true
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/autoscaling-put-autoscaling-policy.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API