› › ›

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

Регистрирует или обновляет репозиторий снимков.

resp = client.snapshot.create_repository(
    name="my_repository",
    repository={
        "type": "fs",
        "settings": {
            "location": "my_backup_location"
        }
    },
)
print(resp)

response = client.snapshot.create_repository(
  repository: 'my_repository',
  body: {
    type: 'fs',
    settings: {
      location: 'my_backup_location'
    }
  }
)
puts response

const response = await client.snapshot.createRepository({
  name: "my_repository",
  repository: {
    type: "fs",
    settings: {
      location: "my_backup_location",
    },
  },
});
console.log(response);

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. Также может быть установлен на -1, чтобы указать, что запрос никогда не должен истекать.

timeout

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

verify

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

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

Тело запроса

type

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

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

azure: Репозиторий Azure
gcs: Репозиторий Google Cloud Storage
s3: Репозиторий S3
fs: Репозиторий общей файловой системы
source: Репозиторий только источника
url: Репозиторий с чтением только для URL

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

hdfs: Репозиторий Hadoop Distributed File System (HDFS)

settings

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

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

Репозиторий Hadoop Distributed File System (HDFS)

verify

Вы можете выполнить эту проверку вручную, используя 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/8.17/put-snapshot-repo-api.html