› › ›

API создания или обновления хранилища снимков

Регистрирует или обновляет хранилище снимков.

PUT /_snapshot/my_repository
{
  "type": "fs",
  "settings": {
    "location": "my_backup_location"
  }
}

Запрос

PUT /_snapshot/<repository>

POST /_snapshot/<repository>

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

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

Для регистрации хранилища снимков глобальные метаданные кластера должны быть доступны для записи. Убедитесь, что нет блоков кластера, которые препятствуют доступу для записи.

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

<repository>: (Обязательный, строка) Имя хранилища снимков для регистрации или обновления.

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

Некоторые параметры этого API можно указать с помощью параметра запроса или параметра тела запроса. Если оба параметра указаны, используется только параметр запроса.

master_timeout

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

timeout

(Необязательный, единицы времени) Указывает период времени ожидания ответа. Если ответ не получен до истечения срока ожидания, запрос завершается ошибкой. По умолчанию 30s.

verify

(Необязательный, булево) Если true, запрос проверяет работоспособность хранилища на всех узлах-мастерах и данных в кластере. Если false, эта проверка пропускается. По умолчанию true.

Вы можете выполнить эту проверку вручную, используя API проверки хранилища снимков.

Тело запроса

type

(Обязательно, строка) Тип репозитория.

Допустимые значения для type

fs

Репозиторий файловой системы общего доступа. Репозитории этого типа используют общую файловую систему для хранения снимков. Эта файловая система должна быть доступна всем мастер- и данным узлам в кластере.

Для регистрации репозитория общей файловой системы необходимо смонтировать одну и ту же общую файловую систему в одном и том же месте на всех мастер- и данных узлах. Это место должно быть зарегистрировано в настройке path.repo на всех мастер- и данных узлах в кластере.

См. Репозиторий файловой системы общего доступа.

source

Репозиторий только исходных данных. Вы можете использовать репозитории только исходных данных для создания минимальных снимков только исходных данных, занимающих до 50% меньше места на диске.

Снимки только исходных данных поддерживаются только в том случае, если поле _source включено и не применяется фильтрация исходных данных.

Снимки только исходных данных содержат хранимые поля и метаданные индекса. Они не включают структуры индексов или значений документов и не подлежат поиску при восстановлении. После восстановления снимка только исходных данных необходимо переиндексировать данные в новый индекс.

См. Репозиторий только исходных данных.

url

Репозиторий URL. Репозитории этого типа являются только для чтения для кластера. Это означает, что кластер может извлекать или восстанавливать снимки из репозитория, но не может записывать или создавать снимки в нём.

Вы можете использовать репозитории URL в качестве альтернативного способа предоставления кластеру только чтения доступа к общей файловой системе (fs) репозитория.

См. Репозиторий URL только для чтения.

Доступны и другие типы репозиториев через эти официальные плагины:

repository-s3 для поддержки репозиториев S3
repository-hdfs для поддержки репозиториев HDFS в средах Hadoop
repository-azure для репозиториев хранилища Azure
repository-gcs для репозиториев хранилища Google Cloud

settings

(Обязательно, объект) Содержит настройки для репозитория.

Следующие settings свойства допустимы для всех типов репозиториев:

Свойства settings

chunk_size

(Необязательно, значение байта) Максимальный размер файлов в снимках. В снимках файлы, превышающие этот размер, разбиваются на фрагменты этого размера или меньше. По умолчанию null (неограниченный размер файла).

compress

(Необязательно, Булево) Если true, метаданные, такие как схемы и настройки индекса, сжимаются в снимках. Файлы данных не сжимаются. По умолчанию true.

max_number_of_snapshots

(Необязательно, целое число) Максимальное количество снимков, которое может содержать репозиторий. По умолчанию 500.

Не рекомендуется увеличивать max_number_of_snapshots. Более крупные репозитории снимков могут ухудшить производительность мастер-узла и привести к проблемам стабильности. Вместо этого удаляйте старые снимки или используйте несколько репозиториев.

max_restore_bytes_per_sec

(Необязательно, значение байта) Максимальная скорость восстановления снимков на узел. По умолчанию неограниченная. Обратите внимание, что восстановления также ограничиваются через настройки восстановления.

max_snapshot_bytes_per_sec

(Необязательно, значение байта) Максимальная скорость создания снимков на узел. По умолчанию 40mb в секунду.

readonly

(Необязательно, Булево) Если true, репозиторий является только для чтения. Кластер может извлекать и восстанавливать снимки из репозитория, но не может записывать в репозиторий или создавать в нём снимки.

Если false, кластер может записывать в репозиторий и создавать в нём снимки. По умолчанию false.

Если вы регистрируете один и тот же репозиторий снимков с несколькими кластерами, только один кластер должен иметь доступ к записи в репозиторий. Наличие нескольких кластеров, записывающих в репозиторий одновременно, может привести к повреждению содержимого репозитория.

Только кластер с правом записи может создавать снимки в репозитории. Все остальные кластеры, подключённые к репозиторию, должны иметь параметр readonly, установленный в true. Это означает, что эти кластеры могут извлекать или восстанавливать снимки из репозитория, но не могут создавать снимки в нём.

Другие допустимые settings свойства зависят от типа репозитория, установленные с помощью параметра type.

Допустимые settings свойства для репозиториев fs

location: (Обязательно, строка) Путь к общей файловой системе, используемой для хранения и извлечения снимков. Это место должно быть зарегистрировано в настройке path.repo на всех мастер- и данных узлах в кластере.

Допустимые settings свойства для репозиториев source

delegate_type

(Необязательно, строка) Делегированный тип репозитория. Допустимые значения см. в параметре type.

Репозитории source могут использовать свойства settings для своего делегированного типа репозитория. См. Репозиторий только исходных данных.

Допустимые settings свойства для репозиториев url

url

(Обязательно, строка) URL-путь к корню репозитория общей файловой системы. Поддерживаются следующие протоколы:

file
ftp
http
https
jar

URL, использующие протоколы http, https или ftp, должны быть явно разрешены с помощью настройки кластера repositories.url.allowed_urls. Эта настройка поддерживает подстановочные знаки вместо хоста, пути, запроса или фрагмента в URL.

URL, использующие протокол file, должны указывать на расположение общей файловой системы, доступной всем мастер- и данным узлам в кластере. Это расположение должно быть зарегистрировано в настройке path.repo. Вам не нужно регистрировать URL, использующие протоколы ftp, http, https или jar в настройке path.repo. ---

http_max_retries: (Необязательно, целое число) Максимальное количество попыток повторного подключения для URL http и https. По умолчанию 5.
http_socket_timeout: (Необязательно, значение времени) Максимальное время ожидания для передачи данных по подключению. По умолчанию 50s.

verify

(Необязательно, Булево) Если true, запрос проверяет, работает ли репозиторий на всех мастер- и данных узлах в кластере. Если false, эта проверка пропускается. По умолчанию true.

Вы можете вручную выполнить эту проверку, используя API проверки репозитория снимков.

© 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/7.17/put-snapshot-repo-api.html

END_OF_DOCUMENT_MARKER