Link Search Menu Expand Document Documentation Menu
文档

获取快照

1.0 版引入

检索有关快照的信息。

端点

GET _snapshot/<repository>/<snapshot>/

路径参数

参数 数据类型 描述
repository 字符串 包含要检索快照的存储库。
快照 字符串 要检索的快照。

查询参数

参数 数据类型 描述
verbose 布尔型 当为 true 时，返回每个快照的附加信息，例如拍摄快照的 OpenSearch 版本、快照的开始和结束时间以及快照中包含的分片数量。当为 false 时，仅返回快照名称和包含的索引。这在快照属于基于云的存储库时非常有用，因为每次读取 blob 都会产生成本或性能问题。可选。默认值为 true。
ignore_unavailable 布尔型 如何处理不可用（已损坏或暂时无法返回）的快照。如果为 true 且快照不可用，则请求不返回该快照。如果为 false 且快照不可用，则请求返回错误。可选。默认值为 false。

请求示例

以下请求检索位于 my-opensearch-repo 存储库中的 my-first-snapshot 的信息

GET _snapshot/my-opensearch-repo/my-first-snapshot

示例响应

成功后，响应返回快照信息

{
  "snapshots" : [
    {
      "snapshot" : "my-first-snapshot",
      "uuid" : "3P7Qa-M8RU6l16Od5n7Lxg",
      "version_id" : 136217927,
      "version" : "2.0.1",
      "indices" : [
        ".opensearch-observability",
        ".opendistro-reports-instances",
        ".opensearch-notifications-config",
        "shakespeare",
        ".opendistro-reports-definitions",
        "opensearch_dashboards_sample_data_flights",
        ".kibana_1"
      ],
      "data_streams" : [ ],
      "include_global_state" : true,
      "state" : "SUCCESS",
      "start_time" : "2022-08-11T20:30:00.399Z",
      "start_time_in_millis" : 1660249800399,
      "end_time" : "2022-08-11T20:30:14.851Z",
      "end_time_in_millis" : 1660249814851,
      "duration_in_millis" : 14452,
      "failures" : [ ],
      "shards" : {
        "total" : 7,
        "failed" : 0,
        "successful" : 7
      }
    }
  ]
}

响应正文字段

字段 数据类型 描述
快照 字符串 快照名称。
uuid 字符串 快照的通用唯一标识符 (UUID)。
version_id 整数 创建快照的 OpenSearch 版本的构建 ID。
version 浮点型 创建快照的 OpenSearch 版本。
索引 数组 快照中的索引。
数据流 数组 快照中的数据流。
include_global_state 布尔值 当前集群状态是否包含在快照中。
start_time 字符串 快照创建过程开始的日期/时间。
start_time_in_millis 长整型 (long) 快照创建过程开始的时间（毫秒）。
结束时间 字符串 快照创建过程结束的日期/时间。
end_time_in_millis 长整型 (long) 快照创建过程结束的时间（毫秒）。
duration_in_millis 长整型 (long) 快照创建过程持续的总时间（毫秒）。
failures 数组 快照创建过程中发生的任何失败。
分片 对象 创建的分片总数以及成功和失败的分片数量。
state 字符串 快照状态。可能的值：IN_PROGRESS（进行中）、SUCCESS（成功）、FAILED（失败）、PARTIAL（部分完成）。
剩余 350 字符

有问题？。

想要贡献？ 或 。