Link Search Menu Expand Document Documentation Menu
文档

创建快照

1.0 版引入

在现有仓库中创建快照。

  • 要了解有关快照的更多信息，请参阅快照。

  • 要查看您的仓库列表，请参阅获取快照仓库。

端点

PUT /_snapshot/<repository>/<snapshot>
POST /_snapshot/<repository>/<snapshot>

路径参数

参数 数据类型 描述
repository（仓库） 字符串 用于存储快照的仓库名称。
快照 字符串 要创建的快照的名称。

查询参数

参数 数据类型 描述
wait_for_completion 布尔型 是否等待快照创建完成再继续。如果您包含此参数，则快照定义将在完成后返回。

请求正文字段

请求体是可选的。

字段 数据类型 描述
索引 字符串 您要包含在快照中的索引。您可以使用,创建索引列表，*指定索引模式，以及-排除某些索引。项目之间不要留空格。默认是所有索引。
ignore_unavailable 布尔型 如果indices列表中的索引不存在，是忽略它而不是使快照失败。默认值为false。
include_global_state 布尔型 是否在快照中包含集群状态。默认值为true。
partial 布尔型 是否允许部分快照。默认值为false，如果一个或多个分片存储失败，则会导致整个快照失败。

示例请求

不带请求体的请求

以下请求在名为my-s3-repository的 S3 仓库中创建一个名为my-first-snapshot的快照。不包含请求体，因为它是可选的。

POST _snapshot/my-s3-repository/my-first-snapshot

带请求体的请求

您还可以添加请求体以包含或排除某些索引或指定其他设置。

PUT _snapshot/my-s3-repository/2
{
  "indices": "opensearch-dashboards*,my-index*,-my-index-2016",
  "ignore_unavailable": true,
  "include_global_state": false,
  "partial": false
}

示例响应

成功后，响应内容取决于您是否包含wait_for_completion查询参数。

未包含wait_for_completion
{
  "accepted": true
}

要验证快照是否已创建，请使用获取快照 API，将快照名称作为snapshot路径参数传入。

已包含wait_for_completion

返回快照定义。

{
  "snapshot" : {
    "snapshot" : "5",
    "uuid" : "ZRH4Zv7cSnuYev2JpLMJGw",
    "version_id" : 136217927,
    "version" : "2.0.1",
    "indices" : [
      ".opendistro-reports-instances",
      ".opensearch-observability",
      ".kibana_1",
      "opensearch_dashboards_sample_data_flights",
      ".opensearch-notifications-config",
      ".opendistro-reports-definitions",
      "shakespeare"
    ],
    "data_streams" : [ ],
    "include_global_state" : true,
    "state" : "SUCCESS",
    "start_time" : "2022-08-10T16:52:15.277Z",
    "start_time_in_millis" : 1660150335277,
    "end_time" : "2022-08-10T16:52:18.699Z",
    "end_time_in_millis" : 1660150338699,
    "duration_in_millis" : 3422,
    "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 数组 快照创建过程中发生的任何故障。
分片 object 创建的分片总数以及成功和失败的分片数量。
state 字符串 快照状态。可能的值：IN_PROGRESS（进行中）、SUCCESS（成功）、FAILED（失败）、PARTIAL（部分）。
remote_store_index_shallow_copy 布尔型 远程存储索引的快照是否捕获为浅拷贝。默认值为false。
pinned_timestamp 长整型 (long) 快照为隐式锁定快照引用的远程存储文件而固定的时间戳（毫秒）。
剩余 350 字符

有问题？。

想要贡献？或。