创建或更新快照存储库 API
编辑创建或更新快照存储库 API编辑
注册或更新 快照存储库。
response = client.snapshot.create_repository(
repository: 'my_repository',
body: {
type: 'fs',
settings: {
location: 'my_backup_location'
}
}
)
puts response
PUT /_snapshot/my_repository
{
"type": "fs",
"settings": {
"location": "my_backup_location"
}
}
如果您要迁移 可搜索快照，则存储库的名称在源集群和目标集群中必须相同。
先决条件编辑
- 如果启用了 Elasticsearch 安全功能，则您必须拥有
manage集群权限 才能使用此 API。
- 要注册快照存储库，集群的全局元数据必须是可写的。确保没有任何 集群块 阻止写入访问。
路径参数编辑
-
<repository> - （必填，字符串）要注册或更新的快照存储库的名称。
查询参数编辑
此 API 的几个选项可以使用查询参数或请求正文参数指定。如果同时指定了这两个参数，则仅使用查询参数。
-
master_timeout - （可选，时间单位）等待主节点的时间段。如果在超时到期之前主节点不可用，则请求失败并返回错误。默认为
30s。也可以设置为-1以指示请求永不超时。 -
timeout - （可选，时间单位）指定等待响应的时间段。如果在超时到期之前未收到响应，则请求失败并返回错误。默认为
30s。 -
verify -
（可选，布尔值）如果为
true，则请求会验证存储库在集群中的所有主节点和数据节点上是否正常运行。如果为false，则跳过此验证。默认为true。您可以使用 验证快照存储库 API 手动执行此验证。
请求正文编辑
-
type -
（必填，字符串）存储库类型。
type的有效值-
azure - Azure 存储库
-
gcs - Google Cloud Storage 存储库
-
s3 - S3 存储库
-
fs - 共享文件系统存储库
-
source - 仅限源的存储库
-
url - 只读 URL 存储库
其他存储库类型可通过官方插件获得
-
-
settings -
（必填，对象）存储库的设置。支持的设置因存储库类型而异
其他存储库类型可通过官方插件获得
-
verify -
（可选，布尔值）如果为
true，则请求会验证存储库在集群中的所有主节点和数据节点上是否正常运行。如果为false，则跳过此验证。默认为true。您可以使用 验证快照存储库 API 手动执行此验证。