› › ›

API получения информации о репозитории моментальных снимков

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

resp = client.snapshot.get_repository(
    name="my_repository",
)
print(resp)

response = client.snapshot.get_repository(
  repository: 'my_repository'
)
puts response

const response = await client.snapshot.getRepository({
  name: "my_repository",
});
console.log(response);

GET /_snapshot/my_repository

Запрос

GET /_snapshot/<repository>

GET /_snapshot

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

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

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

<repository>

(Необязательный, строка) Список имён репозиториев моментальных снимков, разделённых запятыми, используемый для ограничения запроса. Поддерживаются шаблоны с подстановкой (*), включая комбинацию шаблонов с исключающими образцами, начинающимися с -.

Чтобы получить информацию обо всех репозиториях моментальных снимков, зарегистрированных в кластере, опустите этот параметр или используйте * или _all.

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

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

Тело ответа

<repository>

(объект) Содержит информацию о репозитории моментального снимка. Ключ — имя репозитория моментального снимка.

Свойства <repository>

type

(строка) Тип репозитория.

Значения для type

fs: Репозиторий файловой системы общего доступа. См. Репозиторий файловой системы общего доступа.
source: Репозиторий, работающий только с исходными данными. См. Репозиторий, работающий только с исходными данными.
url: Репозиторий URL. См. Репозиторий URL только для чтения.

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

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

settings

(объект) Содержит параметры для репозитория. Допустимые свойства для объекта settings зависят от типа репозитория, установленного с помощью параметра type.

Для свойств см. создание или обновление API репозитория моментального снимка с settings параметром.

Примеры

resp = client.snapshot.get_repository(
    name="my_repository",
)
print(resp)

response = client.snapshot.get_repository(
  repository: 'my_repository'
)
puts response

const response = await client.snapshot.getRepository({
  name: "my_repository",
});
console.log(response);

GET /_snapshot/my_repository

API возвращает следующий ответ:

{
  "my_repository" : {
    "type" : "fs",
    "uuid" : "0JLknrXbSUiVPuLakHjBrQ",
    "settings" : {
      "location" : "my_backup_location"
    }
  }
}

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