› › ›

API cat repositories

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

Возвращает репозитории снимков для кластера.

Запрос

GET /_cat/repositories

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

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

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

format: (Необязательно, строка) Короткая версия заголовка HTTP accept. Допустимые значения включают JSON, YAML и т. д.
h: (Необязательно, строка) Список столбцов, разделяемых запятыми, для отображения.
help: (Необязательно, логическое значение) Если true, ответ включает справочную информацию. По умолчанию false.
local: (Необязательно, логическое значение) Если true, запрос получает информацию только с локального узла. По умолчанию false, что означает получение информации с узла-мастера.
master_timeout: (Необязательно, единицы времени) Период ожидания подключения к узлу-мастеру. Если ответ не получен до истечения времени ожидания, запрос завершается ошибкой и возвращает ошибку. По умолчанию 30s.
s: (Необязательно, строка) Список столбцов или псевдонимов столбцов, разделенных запятыми, используемых для сортировки ответа.
v: (Необязательно, логическое значение) Если true, ответ включает заголовки столбцов. По умолчанию false.

Примеры

GET /_cat/repositories?v=true

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

id    type
repo1   fs
repo2   s3

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