› › ›

API cat snapshots

API cat предназначены только для использования человеком с помощью командной строки или консоли Kibana. Они не предназначены для использования приложениями. Для использования приложениями используйте API получения снимков.

Возвращает информацию о снимках, хранящихся в одном или нескольких репозиториях. Снимок — это резервная копия индекса или работающего кластера Elasticsearch.

Запрос

GET /_cat/snapshots/<repository>

GET /_cat/snapshots

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

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

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

<repository>

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

Если какой-либо репозиторий завершается ошибкой во время запроса, Elasticsearch возвращает ошибку.

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

format

(Необязательно, строка) Короткая версия заголовка HTTP Accept. Допустимые значения включают JSON, YAML и т. д.

h

(Необязательно, строка) Список столбцов для отображения, разделенных запятыми.

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

Допустимые столбцы:

id, snapshot

(По умолчанию) Идентификатор снимка, например, snap1.

repository, re, repo

(По умолчанию) Название репозитория, например, repo1.

status, s

(По умолчанию) Состояние процесса снимка. Возвращаемые значения:

FAILED: Процесс создания снимка завершился ошибкой.
INCOMPATIBLE: Процесс создания снимка несовместим с текущей версией кластера.
IN_PROGRESS: Процесс создания снимка начался, но не завершился.
PARTIAL: Процесс создания снимка завершился с частичным успехом.
SUCCESS: Процесс создания снимка завершился успешно.

start_epoch, ste, startEpoch

(По умолчанию) времени Unix начала процесса снимка.

start_time, sti, startTime

(По умолчанию) Время начала процесса снимка.

end_epoch, ete, endEpoch

(По умолчанию) времени Unix завершения процесса снимка.

end_time, eti, endTime

(По умолчанию) Время завершения процесса снимка.

duration, dur

(По умолчанию) Время, затраченное на завершение процесса снимка, в единицах времени.

indices, i

(По умолчанию) Количество индексов в снимке.

successful_shards, ss

(По умолчанию) Количество успешно обработанных фрагментов в снимке.

failed_shards, fs

(По умолчанию) Количество фрагментов, завершившихся ошибкой, в снимке.

total_shards, ts

(По умолчанию) Общее количество фрагментов в снимке.

reason, r

Причина любых сбоев снимка.

help

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

ignore_unavailable

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

master_timeout

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

s

(Необязательно, строка) Список столбцов или псевдонимов столбцов, разделенных запятыми, для сортировки ответа.

time

(Необязательно, единицы измерения времени) Единица измерения времени.

v

(Необязательно, логическое значение) Если true, ответ включает заголовки столбцов. По умолчанию false.

Примеры

resp = client.cat.snapshots(
    repository="repo1",
    v=True,
    s="id",
)
print(resp)

const response = await client.cat.snapshots({
  repository: "repo1",
  v: "true",
  s: "id",
});
console.log(response);

GET /_cat/snapshots/repo1?v=true&s=id

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

id     repository status start_epoch start_time end_epoch  end_time duration indices successful_shards failed_shards total_shards
snap1  repo1      FAILED 1445616705  18:11:45   1445616978 18:16:18     4.6m       1                 4             1            5
snap2  repo1      SUCCESS 1445634298  23:04:58   1445634672 23:11:12     6.2m       2                10             0           10

© 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/cat-snapshots.html