› › ›

API получения шаблонов компонентов

Получает информацию об одном или нескольких шаблонах компонентов.

resp = client.cluster.get_component_template(
    name="template_1",
)
print(resp)

response = client.cluster.get_component_template(
  name: 'template_1'
)
puts response

const response = await client.cluster.getComponentTemplate({
  name: "template_1",
});
console.log(response);

GET /_component_template/template_1

Запрос

GET /_component_template/<component-template>

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

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

Параметры пути

<component-template>: (Необязательный, строка) Список шаблонов компонентов через запятую для ограничения запроса. Поддерживаются выражения с подстановкой (*).

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

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

Примеры

Получение шаблонов компонентов с использованием выражения подстановки

resp = client.cluster.get_component_template(
    name="temp*",
)
print(resp)

response = client.cluster.get_component_template(
  name: 'temp*'
)
puts response

const response = await client.cluster.getComponentTemplate({
  name: "temp*",
});
console.log(response);

GET /_component_template/temp*

Получение всех шаблонов компонентов

resp = client.cluster.get_component_template()
print(resp)

response = client.cluster.get_component_template
puts response

const response = await client.cluster.getComponentTemplate();
console.log(response);

GET /_component_template

© 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/getting-component-templates.html