› › ›

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

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

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.

Тело ответа

<repository>

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

Свойства <repository>

type

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

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

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

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

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

settings

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

Для получения информации о свойствах см. API создания или обновления репозитория моментальных снимков's settings параметр.

Примеры

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