Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›Cluster API

API кластера get settings

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

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

Возвращает настройки всего кластера.

resp = client.cluster.get_settings()
print(resp)
response = client.cluster.get_settings
puts response
const response = await client.cluster.getSettings();
console.log(response);
GET /_cluster/settings

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

  • Если включены функции безопасности Elasticsearch, у вас должен быть monitor или manage права на доступ к кластеру, чтобы использовать этот API.

Запрос

GET /_cluster/settings

Описание

По умолчанию этот API-вызов возвращает только явно определённые настройки, но также может включать значения по умолчанию, вызвав параметр include_defaults.

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

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

© 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/cluster-get-settings.html

Spec-Zone.ru

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