API монтирования снимка
Смонтировать снимок в качестве поискового индекса снимка.
Запрос
POST /_snapshot/<repository>/<snapshot>/_mount
Предварительные условия
Если включены функции безопасности Elasticsearch, у вас должен быть manage кластерный привилегии и manage индексные привилегии для любого включенного индекса, чтобы использовать этот API. Дополнительную информацию см. в разделе Привилегии безопасности.
Описание
Этот API монтирует снимок в качестве поискового индекса снимка.
Не используйте этот API для снимков, управляемых ILM. Ручное монтирование снимков, управляемых ILM, может влиять на процессы ILM.
Параметры пути
-
<repository> - (Обязательно, строка) Имя репозитория, содержащего снимок индекса, который нужно смонтировать.
-
<snapshot> - (Обязательно, строка) Имя снимка индекса, который нужно смонтировать.
Параметры запроса
-
master_timeout - (Необязательно, единицы времени) Период ожидания мастер-узла. Если мастер-узел недоступен до истечения таймаута, запрос завершается ошибкой. По умолчанию
30s. Также может быть установлено значение-1, чтобы указать, что запрос никогда не должен иметь таймаут. -
wait_for_completion - (Необязательно, булево) Если
true, запрос блокируется до завершения операции. По умолчаниюfalse. -
storage -
(Необязательно, строка) Параметр монтирования для поискового индекса снимка. Возможные значения:
-
full_copy(По умолчанию) - Полностью смонтированный индекс.
-
shared_cache - Частично смонтированный индекс.
-
Тело запроса
-
index - (Обязательно, строка) Имя индекса, содержащегося в снимке, данные которого необходимо смонтировать.
Если renamed_index не указано, это имя также будет использовано для создания нового индекса.
-
renamed_index -
(Необязательно, строка) Имя индекса, который будет создан.
-
index_settings -
(Необязательно, объект) Параметры, которые необходимо добавить к индексу при его монтировании.
-
ignore_index_settings -
(Необязательно, массив строк) Имена параметров, которые необходимо удалить из индекса при его монтировании.
Примеры
Монтирует индекс my_docs из существующего снимка с именем my_snapshot, хранящегося в my_repository, в качестве нового индекса docs:
resp = client.searchable_snapshots.mount(
repository="my_repository",
snapshot="my_snapshot",
wait_for_completion=True,
index="my_docs",
renamed_index="docs",
index_settings={
"index.number_of_replicas": 0
},
ignore_index_settings=[
"index.refresh_interval"
],
)
print(resp) const response = await client.searchableSnapshots.mount({
repository: "my_repository",
snapshot: "my_snapshot",
wait_for_completion: "true",
index: "my_docs",
renamed_index: "docs",
index_settings: {
"index.number_of_replicas": 0,
},
ignore_index_settings: ["index.refresh_interval"],
});
console.log(response); POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true
{
"index": "my_docs",
"renamed_index": "docs",
"index_settings": {
"index.number_of_replicas": 0
},
"ignore_index_settings": [ "index.refresh_interval" ]
} | Имя индекса в снимке для монтирования | |
| Имя индекса для создания | |
| Любые параметры индекса для добавления к новому индексу | |
| Список параметров индекса для игнорирования при монтировании индекса, извлеченного из снимка |
© 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/searchable-snapshots-api-mount-snapshot.html