› › ›

cat 存储库 API

cat 存储库 API编辑

cat API 仅供人类通过命令行或 Kibana 控制台使用。它们*不*适用于应用程序。对于应用程序使用，请使用获取快照存储库 API。

返回集群的快照存储库。

GET /_cat/repositories

如果启用了 Elasticsearch 安全功能，则您必须具有 monitor_snapshot、create_snapshot 或 manage 集群权限才能使用此 API。

format: （可选，字符串）HTTP 接受标头的简短版本。有效值包括 JSON、YAML 等。
h: （可选，字符串）要显示的列名称的逗号分隔列表。
help: （可选，布尔值）如果为 true，则响应包含帮助信息。默认为 false。
local: （可选，布尔值）如果为 true，则请求仅从本地节点检索信息。默认为 false，这意味着从主节点检索信息。
master_timeout: （可选，时间单位）等待主节点的时间段。如果在超时到期之前主节点不可用，则请求失败并返回错误。默认为 30s。也可以设置为 -1 以指示请求永不超时。
s: （可选，字符串）用于对响应进行排序的列名称或列别名的逗号分隔列表。
v: （可选，布尔值）如果为 true，则响应包含列标题。默认为 false。

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

GET /_cat/repositories?v=true

API 返回以下响应

id    type
repo1   fs
repo2   s3