获取快照存储库 API
编辑获取快照存储库 API编辑
获取一个或多个已注册的 快照存储库 的信息。
response = client.snapshot.get_repository( repository: 'my_repository' ) puts response
GET /_snapshot/my_repository
路径参数编辑
-
<repository>
-
(可选,字符串) 用于限制请求的快照存储库名称的逗号分隔列表。支持通配符 (
*
) 表达式,包括使用以-
开头的排除模式与通配符结合。若要获取在集群中注册的所有快照存储库的信息,请省略此参数或使用
*
或_all
。
查询参数编辑
-
local
- (可选,布尔值) 如果为
true
,则请求仅从本地节点获取信息。如果为false
,则请求从主节点获取信息。默认为false
。 -
master_timeout
- (可选,时间单位) 等待主节点的时间段。如果在超时时间到期之前主节点不可用,则请求将失败并返回错误。默认为
30s
。也可以设置为-1
以指示请求永远不应超时。
响应主体编辑
-
<repository>
-
(对象) 包含有关快照存储库的信息。键是快照存储库的名称。
<repository>
的属性-
type
-
(字符串) 存储库类型。
type
的值-
fs
- 共享文件系统存储库。请参阅 共享文件系统存储库。
-
source
- 仅源存储库。请参阅 仅源存储库。
-
url
- URL 存储库。请参阅 只读 URL 存储库。
更多存储库类型可通过这些官方插件获得
- repository-s3,用于 S3 存储库支持
- repository-hdfs,用于 Hadoop 环境中的 HDFS 存储库支持
- repository-azure,用于 Azure 存储库
- repository-gcs,用于 Google Cloud Storage 存储库
-
-
settings
-
(对象) 包含存储库的设置。
settings
对象的有效属性取决于存储库类型,使用type
参数进行设置。有关属性,请参阅 创建或更新快照存储库 API 的
settings
参数。
-
示例编辑
response = client.snapshot.get_repository( repository: 'my_repository' ) puts response
GET /_snapshot/my_repository
API 返回以下响应
{ "my_repository" : { "type" : "fs", "uuid" : "0JLknrXbSUiVPuLakHjBrQ", "settings" : { "location" : "my_backup_location" } } }