创建或更新快照仓库 API
编辑创建或更新快照仓库 API
编辑注册或更新快照仓库。
resp = client.snapshot.create_repository( name="my_repository", repository={ "type": "fs", "settings": { "location": "my_backup_location" } }, ) print(resp)
response = client.snapshot.create_repository( repository: 'my_repository', body: { type: 'fs', settings: { location: 'my_backup_location' } } ) puts response
const response = await client.snapshot.createRepository({ name: "my_repository", repository: { type: "fs", settings: { location: "my_backup_location", }, }, }); console.log(response);
PUT /_snapshot/my_repository { "type": "fs", "settings": { "location": "my_backup_location" } }
如果您正在迁移可搜索快照,则源集群和目标集群中的仓库名称必须相同。
先决条件
编辑- 如果启用了 Elasticsearch 安全功能,您必须具有
manage
集群权限才能使用此 API。
- 要注册快照仓库,集群的全局元数据必须是可写的。确保没有任何阻止写入访问的集群块。
路径参数
编辑-
<repository>
- (必需,字符串)要注册或更新的快照仓库的名称。
查询参数
编辑此 API 的多个选项可以使用查询参数或请求正文参数指定。如果同时指定了这两个参数,则仅使用查询参数。
-
master_timeout
- (可选,时间单位)等待主节点的时间。 如果在超时到期之前主节点不可用,则请求失败并返回错误。默认为
30s
。也可以设置为-1
,表示请求永远不应超时。 -
timeout
- (可选,时间单位)在更新集群元数据后,等待集群中所有相关节点响应的时间。 如果在超时到期之前未收到任何响应,则集群元数据更新仍然适用,但响应将表明它没有被完全确认。 默认为
30s
。也可以设置为-1
,表示请求永远不应超时。 -
verify
-
(可选,布尔值)如果为
true
,则请求验证仓库在集群中的所有主节点和数据节点上是否正常运行。 如果为false
,则跳过此验证。默认为true
。您可以使用验证快照仓库 API手动执行此验证。
请求正文
编辑-
settings
-
(必需,对象)仓库的设置。 支持的设置因仓库类型而异
其他仓库类型可通过官方插件获得
-
verify
-
(可选,布尔值)如果为
true
,则请求验证仓库在集群中的所有主节点和数据节点上是否正常运行。 如果为false
,则跳过此验证。默认为true
。您可以使用验证快照仓库 API手动执行此验证。