Link Search Menu Expand Document Documentation Menu
文档

获取快照状态

1.0 版引入

返回快照创建期间和创建后快照状态的详细信息。

要了解快照创建，请参阅创建快照。

如果您使用安全插件，则必须具有 monitor_snapshot、create_snapshot 或 manage cluster 权限。

端点

GET _snapshot/<repository>/<snapshot>/_status

路径参数

路径参数是可选的。

参数 数据类型 描述
存储库 字符串 包含快照的存储库。
快照 列表 要返回的快照。
索引 列表 响应中要包含的索引。

三种请求变体提供灵活性

  • GET _snapshot/_status 返回所有存储库中所有当前正在运行的快照的状态。

  • GET _snapshot/<repository>/_status 返回指定存储库中所有当前正在运行的快照。这是首选变体。

  • GET _snapshot/<repository>/<snapshot>/_status 返回指定存储库中特定快照的详细状态信息，无论其当前是否正在运行。

  • GET /_snapshot/<repository>/<snapshot>/<index>/_status 仅返回指定存储库中特定快照中指定索引的详细状态信息。请注意，此端点仅适用于属于特定快照的索引。

快照 API 调用仅在请求资源（例如快照和从快照创建的索引）中的分片总数小于以下集群设置指定的限制时才有效

  • snapshot.max_shards_allowed_in_status_api（动态，整数）：可包含在快照状态 API 响应中的分片最大数量。默认值为 200000。不适用于浅层快照 v2，其中文件总数和大小返回为 0。

在云中查询数据时，使用 API 返回非当前运行快照的状态在机器资源和处理时间方面都可能非常耗费成本。对于每个快照，每个请求都会导致读取该快照所有分片的文件。

请求正文字段

字段 数据类型 描述
ignore_unavailable 布尔型 如何处理对不可用快照和索引的请求。如果 false，请求将对不可用的快照和索引返回错误。如果 true，请求将忽略不可用的快照和索引，例如损坏的或暂时无法返回的快照和索引。默认值为 false。

请求示例

以下请求返回 my-opensearch-repo 存储库中 my-first-snapshot 的状态。不可用的快照将被忽略。

GET _snapshot/my-opensearch-repo/my-first-snapshot/_status
{
   "ignore_unavailable": true 
}

示例响应

以下示例对应于“示例请求”部分中的上述请求。

GET _snapshot/my-opensearch-repo/my-first-snapshot/_status 请求返回以下字段

{
  "snapshots" : [
    {
      "snapshot" : "my-first-snapshot",
      "repository" : "my-opensearch-repo",
      "uuid" : "dCK4Qth-TymRQ7Tu7Iga0g",
      "state" : "SUCCESS",
      "include_global_state" : true,
      "shards_stats" : {
        "initializing" : 0,
        "started" : 0,
        "finalizing" : 0,
        "done" : 7,
        "failed" : 0,
        "total" : 7
      },
      "stats" : {
        "incremental" : {
          "file_count" : 31,
          "size_in_bytes" : 24488927
        },
        "total" : {
          "file_count" : 31,
          "size_in_bytes" : 24488927
        },
        "start_time_in_millis" : 1660666841667,
        "time_in_millis" : 14054
      },
      "indices" : {
        ".opensearch-observability" : {
          "shards_stats" : {
            "initializing" : 0,
            "started" : 0,
            "finalizing" : 0,
            "done" : 1,
            "failed" : 0,
            "total" : 1
          },
          "stats" : {
            "incremental" : {
              "file_count" : 1,
              "size_in_bytes" : 208
            },
            "total" : {
              "file_count" : 1,
              "size_in_bytes" : 208
            },
            "start_time_in_millis" : 1660666841868,
            "time_in_millis" : 201
          },
          "shards" : {
            "0" : {
              "stage" : "DONE",
              "stats" : {
                "incremental" : {
                  "file_count" : 1,
                  "size_in_bytes" : 208
                },
                "total" : {
                  "file_count" : 1,
                  "size_in_bytes" : 208
                },
                "start_time_in_millis" : 1660666841868,
                "time_in_millis" : 201
              }
            }
          }
        },
        "shakespeare" : {
          "shards_stats" : {
            "initializing" : 0,
            "started" : 0,
            "finalizing" : 0,
            "done" : 1,
            "failed" : 0,
            "total" : 1
          },
          "stats" : {
            "incremental" : {
              "file_count" : 4,
              "size_in_bytes" : 18310117
            },
            "total" : {
              "file_count" : 4,
              "size_in_bytes" : 18310117
            },
            "start_time_in_millis" : 1660666842470,
            "time_in_millis" : 13050
          },
          "shards" : {
            "0" : {
              "stage" : "DONE",
              "stats" : {
                "incremental" : {
                  "file_count" : 4,
                  "size_in_bytes" : 18310117
                },
                "total" : {
                  "file_count" : 4,
                  "size_in_bytes" : 18310117
                },
                "start_time_in_millis" : 1660666842470,
                "time_in_millis" : 13050
              }
            }
          }
        },
        "opensearch_dashboards_sample_data_flights" : {
          "shards_stats" : {
            "initializing" : 0,
            "started" : 0,
            "finalizing" : 0,
            "done" : 1,
            "failed" : 0,
            "total" : 1
          },
          "stats" : {
            "incremental" : {
              "file_count" : 10,
              "size_in_bytes" : 6132245
            },
            "total" : {
              "file_count" : 10,
              "size_in_bytes" : 6132245
            },
            "start_time_in_millis" : 1660666843476,
            "time_in_millis" : 6221
          },
          "shards" : {
            "0" : {
              "stage" : "DONE",
              "stats" : {
                "incremental" : {
                  "file_count" : 10,
                  "size_in_bytes" : 6132245
                },
                "total" : {
                  "file_count" : 10,
                  "size_in_bytes" : 6132245
                },
                "start_time_in_millis" : 1660666843476,
                "time_in_millis" : 6221
              }
            }
          }
        },
        ".opendistro-reports-definitions" : {
          "shards_stats" : {
            "initializing" : 0,
            "started" : 0,
            "finalizing" : 0,
            "done" : 1,
            "failed" : 0,
            "total" : 1
          },
          "stats" : {
            "incremental" : {
              "file_count" : 1,
              "size_in_bytes" : 208
            },
            "total" : {
              "file_count" : 1,
              "size_in_bytes" : 208
            },
            "start_time_in_millis" : 1660666843076,
            "time_in_millis" : 200
          },
          "shards" : {
            "0" : {
              "stage" : "DONE",
              "stats" : {
                "incremental" : {
                  "file_count" : 1,
                  "size_in_bytes" : 208
                },
                "total" : {
                  "file_count" : 1,
                  "size_in_bytes" : 208
                },
                "start_time_in_millis" : 1660666843076,
                "time_in_millis" : 200
              }
            }
          }
        },
        ".opendistro-reports-instances" : {
          "shards_stats" : {
            "initializing" : 0,
            "started" : 0,
            "finalizing" : 0,
            "done" : 1,
            "failed" : 0,
            "total" : 1
          },
          "stats" : {
            "incremental" : {
              "file_count" : 1,
              "size_in_bytes" : 208
            },
            "total" : {
              "file_count" : 1,
              "size_in_bytes" : 208
            },
            "start_time_in_millis" : 1660666841667,
            "time_in_millis" : 201
          },
          "shards" : {
            "0" : {
              "stage" : "DONE",
              "stats" : {
                "incremental" : {
                  "file_count" : 1,
                  "size_in_bytes" : 208
                },
                "total" : {
                  "file_count" : 1,
                  "size_in_bytes" : 208
                },
                "start_time_in_millis" : 1660666841667,
                "time_in_millis" : 201
              }
            }
          }
        },
        ".kibana_1" : {
          "shards_stats" : {
            "initializing" : 0,
            "started" : 0,
            "finalizing" : 0,
            "done" : 1,
            "failed" : 0,
            "total" : 1
          },
          "stats" : {
            "incremental" : {
              "file_count" : 13,
              "size_in_bytes" : 45733
            },
            "total" : {
              "file_count" : 13,
              "size_in_bytes" : 45733
            },
            "start_time_in_millis" : 1660666842673,
            "time_in_millis" : 2007
          },
          "shards" : {
            "0" : {
              "stage" : "DONE",
              "stats" : {
                "incremental" : {
                  "file_count" : 13,
                  "size_in_bytes" : 45733
                },
                "total" : {
                  "file_count" : 13,
                  "size_in_bytes" : 45733
                },
                "start_time_in_millis" : 1660666842673,
                "time_in_millis" : 2007
              }
            }
          }
        },
        ".opensearch-notifications-config" : {
          "shards_stats" : {
            "initializing" : 0,
            "started" : 0,
            "finalizing" : 0,
            "done" : 1,
            "failed" : 0,
            "total" : 1
          },
          "stats" : {
            "incremental" : {
              "file_count" : 1,
              "size_in_bytes" : 208
            },
            "total" : {
              "file_count" : 1,
              "size_in_bytes" : 208
            },
            "start_time_in_millis" : 1660666842270,
            "time_in_millis" : 200
          },
          "shards" : {
            "0" : {
              "stage" : "DONE",
              "stats" : {
                "incremental" : {
                  "file_count" : 1,
                  "size_in_bytes" : 208
                },
                "total" : {
                  "file_count" : 1,
                  "size_in_bytes" : 208
                },
                "start_time_in_millis" : 1660666842270,
                "time_in_millis" : 200
              }
            }
          }
        }
      }
    }
  ]
}

响应正文字段

字段 数据类型 描述
存储库 字符串 包含快照的存储库名称。
快照 字符串 快照名称。
uuid 字符串 快照的通用唯一标识符 (UUID)。
state 字符串 快照的当前状态。请参阅快照状态。
include_global_state 布尔型 当前集群状态是否包含在快照中。
shards_stats 对象 快照的分片计数。请参阅分片统计。
stats 对象 关于快照中包含的文件的信息。file_count：文件数量。size_in_bytes：所有文件的总大小。请参阅快照文件统计。
索引 对象列表 包含快照中索引信息的对象列表。请参阅索引对象。

快照状态

状态 描述
FAILED（失败） 快照因错误终止，未存储任何数据。
IN_PROGRESS（进行中） 快照当前正在运行。
PARTIAL（部分完成） 全局集群状态已存储，但至少一个分片的数据未存储。创建快照响应的 failures 属性包含更多详细信息。
SUCCESS（成功） 快照完成，所有分片均成功存储。

分片统计

所有属性值均为整数。

属性 描述
initializing（初始化中） 仍在初始化中的分片数量。
started（已启动） 已启动但尚未完成的分片数量。
finalizing（正在完成） 正在完成但尚未完成的分片数量。
done（已完成） 已成功初始化、启动和完成的分片数量。
failed（失败） 未能包含在快照中的分片数量。
total（总计） 快照中包含的分片总数。

快照文件统计

属性 类型 描述
incremental（增量） 对象 快照创建期间仍需复制的文件数量和大小。对于已完成的快照，incremental 提供尚未在存储库中且作为增量快照的一部分进行复制的文件数量和大小。
processed（已处理） 对象 已上传到快照的文件数量和大小。在文件上传后，已处理的 file_count 和 size_in_bytes 会在统计信息中递增。
total（总计） 对象 快照引用的文件总数和总大小。
start_time_in_millis 长整型 快照创建开始时间（毫秒）。
time_in_millis 长整型 快照完成所需总时间（毫秒）。

索引对象

属性 类型 描述
shards_stats 对象 请参阅分片统计。
stats 对象 请参阅快照文件统计。
分片 对象列表 包含快照中分片的信息。OpenSearch 返回关于分片的以下属性：

stage：快照中分片的当前状态。分片状态如下：

* DONE（已完成）：快照中成功存储在存储库中的分片数量。

* FAILURE（失败）：快照中未成功存储在存储库中的分片数量。

* FINALIZE（正在完成）：快照中处于存储库存储完成阶段的分片数量。

* INIT（初始化中）：快照中处于存储库存储初始化阶段的分片数量。

* STARTED（已启动）：快照中处于存储库存储启动阶段的分片数量。

stats：请参阅快照文件统计。

total：快照引用的文件总数和总大小。

start_time_in_millis：快照创建开始的时间（毫秒）。

time_in_millis：快照完成所花费的总时间（毫秒）。
剩余 350 字符

有问题？。

想贡献？ 或 。