› › ›

获取快照仓库 API

获取一个或多个已注册的快照仓库的信息。

resp = client.snapshot.get_repository(
    name="my_repository",
)
print(resp)

response = client.snapshot.get_repository(
  repository: 'my_repository'
)
puts response

const response = await client.snapshot.getRepository({
  name: "my_repository",
});
console.log(response);

GET /_snapshot/my_repository

请求

编辑

GET /_snapshot/<repository>

GET /_snapshot

先决条件

编辑

如果启用了 Elasticsearch 安全功能，您必须拥有 monitor_snapshot、create_snapshot 或 manage 集群权限才能使用此 API。

路径参数

编辑

<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 参数。

示例

编辑

resp = client.snapshot.get_repository(
    name="my_repository",
)
print(resp)

response = client.snapshot.get_repository(
  repository: 'my_repository'
)
puts response

const response = await client.snapshot.getRepository({
  name: "my_repository",
});
console.log(response);

GET /_snapshot/my_repository

API 返回以下响应

{
  "my_repository" : {
    "type" : "fs",
    "uuid" : "0JLknrXbSUiVPuLakHjBrQ",
    "settings" : {
      "location" : "my_backup_location"
    }
  }
}

« 验证仓库完整性 API 删除快照仓库 API »