获取快照仓库。
1.0 版引入
检索快照仓库的信息。
要了解更多关于仓库的信息,请参阅注册仓库。
您还可以在快照创建期间和之后获取快照的详细信息。请参阅获取快照状态。
端点
GET /_snapshot/<repository>
路径参数
参数 | 数据类型 | 描述 |
---|---|---|
repository | 字符串 | 要检索的快照仓库名称,以逗号分隔。支持通配符 (* ) 表达式,包括通配符与以 - 开头的排除模式的组合。 |
查询参数
参数 | 数据类型 | 描述 |
---|---|---|
local | 布尔型 | 是否从本地节点获取信息。可选,默认为 false 。 |
cluster_manager_timeout | 时间 | 等待连接到集群管理器节点的时间。可选,默认为 30 秒。 |
请求示例
以下请求检索 my-opensearch-repo
仓库的信息
GET /_snapshot/my-opensearch-repo
示例响应
成功后,响应会返回仓库信息。此示例适用于 s3
仓库类型。
{
"my-opensearch-repo" : {
"type" : "s3",
"settings" : {
"bucket" : "my-open-search-bucket",
"base_path" : "snapshots"
}
}
}
响应正文字段
字段 | 数据类型 | 描述 |
---|---|---|
type | 字符串 | 桶类型:fs (文件系统)或 s3 (S3 桶) |
bucket | 字符串 | S3 桶名称。 |
base_path | 字符串 | 桶中存储快照的文件夹。 |