› › ›

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. Также может быть установлен на -1, чтобы указать, что запрос никогда не должен истекать.
s: (Необязательно, строка) Список имен столбцов или псевдонимов столбцов через запятую для сортировки ответа.
v: (Необязательно, булево) Если true, ответ включает заголовки столбцов. По умолчанию false.

Примеры

resp = client.cat.repositories(
    v=True,
)
print(resp)

response = client.cat.repositories(
  v: true
)
puts response

const response = await client.cat.repositories({
  v: "true",
});
console.log(response);

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