注册或更新快照存储库

1.0 版引入

您可以使用快照 API 注册新的存储库以存储快照，或更新现有存储库的信息。

快照存储库有两种类型

• 文件系统（fs）：有关创建 fs 存储库的说明，请参阅注册共享文件系统存储库。

• Amazon 简单存储服务 (Amazon S3) 存储桶（s3）：有关创建 s3 存储库的说明，请参阅注册 Amazon S3 存储库。

有关创建存储库的说明，请参阅注册存储库。

端点

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

路径参数

请求参数

请求参数取决于存储库的类型：fs 或 s3。

通用参数

下表列出了 fs 和 s3 存储库均可使用的参数。

shard_path_type 值

shard_path_type 设置中支持以下值

• FIXED：保持现有分层路径结构，例如 <ROOT>/<BASE_PATH>/indices/<index-id>/0/<SHARD_BLOBS>。
• HASHED_PREFIX：为每个唯一分片 ID 在路径开头添加哈希前缀，例如 <ROOT>/<HASH-OF-INDEX-ID-AND-SHARD-ID>/<BASE_PATH>/indices/<index-id>/0/<SHARD_BLOBS>。
• HASHED_INFIX：为每个唯一分片 ID 在基路径后附加哈希前缀，例如 <ROOT>/<BASE-PATH>/<HASH-OF-INDEX-ID-AND-SHARD-ID>/indices/<index-id>/0/<SHARD_BLOBS>。使用的哈希方法是 FNV_1A_COMPOSITE_1，它使用 FNV1a 哈希函数并生成自定义编码的 64 位哈希值，该值可很好地与大多数远程存储选项配合使用。FNV1a 取最高 6 位创建 URL 安全的 Base64 字符，取接下来的 14 位创建二进制字符串。

fs 存储库

s3 存储库

对于 base_path 参数，在输入 S3 存储桶详细信息时，请勿输入 s3:// 前缀。只需存储桶的名称。

从 OpenSearch 3.1.0 开始，server_side_encryption 设置已移除。S3 将服务器端加密作为所有 S3 存储桶的基本加密级别。由于此功能无法禁用，此值存储库设置无效。有关更多信息，请参阅使用服务器端加密保护数据。

示例请求

文件系统

以下示例注册了一个 fs 仓库，使用本地目录 /mnt/snapshots 作为 location

PUT /_snapshot/my-fs-repository
{
  "type": "fs",
  "settings": {
    "location": "/mnt/snapshots"
  }
}

S3

以下请求注册了一个新的 S3 仓库，名为 my-opensearch-repo，位于名为 my-open-search-bucket 的现有存储桶中。默认情况下，所有快照都存储在 my/snapshot/directory 中

PUT /_snapshot/my-opensearch-repo
{
  "type": "s3",
  "settings": {
    "bucket": "my-open-search-bucket",
    "base_path": "my/snapshot/directory"
  }
}

以下请求注册了一个新的 S3 仓库，名为 my-opensearch-repo，位于名为 my-open-search-bucket 的现有存储桶中。默认情况下，所有快照都存储在 my/snapshot/directory 中。此外，此仓库配置为使用 SSE-KMS，并且预期的存储桶所有者 AWS 账户 ID 为 123456789000。

PUT /_snapshot/my-opensearch-repo
{
  "type": "s3",
  "settings": {
    "bucket": "my-open-search-bucket",
    "base_path": "my/snapshot/directory",
    "server_side_encryption_type": "aws:kms",
    "server_side_encryption_kms_key_id": "arn:aws:kms:us-east-1:123456789000:key/kms-key-id",
    "server_side_encryption_encryption_context": "{\"additional-enc-ctx\": \"sample-context\"}",
    "expected_bucket_owner": "123456789000",
  }
}
'

示例响应

成功后，将返回以下 JSON 对象

{
  "acknowledged": true
}

要验证仓库是否已注册，请使用 获取快照仓库 API，将仓库名称作为 repository 路径参数传递。