cat 快照 API
编辑cat 快照 API
编辑cat API 仅供人类通过命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用 获取快照 API。
返回有关存储在一个或多个存储库中的 快照的信息。快照是索引或正在运行的 Elasticsearch 集群的备份。
路径参数
编辑-
<repository> -
（可选，字符串）用于限制请求的快照存储库的逗号分隔列表。接受通配符表达式。
_all返回所有存储库。如果在请求期间任何存储库失败，Elasticsearch 将返回错误。
查询参数
编辑-
format - （可选，字符串）HTTP accept 标头的简短版本。有效值包括 JSON、YAML 等。
-
h -
（可选，字符串）要显示的列名的逗号分隔列表。
如果您未指定要包括哪些列，API 将按下列顺序返回默认列。如果您明确指定一个或多个列，则只会返回指定的列。
有效的列是
-
id,snapshot - （默认）快照的 ID，例如
snap1。 -
repository,re,repo - （默认）存储库的名称，例如
repo1。 -
status,s -
（默认）快照进程的状态。返回的值为
-
FAILED：快照进程失败。 -
INCOMPATIBLE：快照进程与当前集群版本不兼容。 -
IN_PROGRESS：快照进程已启动但尚未完成。 -
PARTIAL：快照进程完成，但部分成功。 -
SUCCESS：快照进程完全成功完成。
-
-
start_epoch,ste,startEpoch - （默认）快照进程开始时的 Unix
epoch时间。 -
start_time,sti,startTime - （默认）快照进程开始时的
HH:MM:SS时间。 -
end_epoch,ete,endEpoch - （默认）快照进程结束时的 Unix
epoch时间。 -
end_time,eti,endTime - （默认）快照进程结束时的
HH:MM:SS时间。 -
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