验证快照仓库
1.0 版引入
验证快照仓库是否正常运行。在集群中的每个节点上验证仓库。
如果验证成功,验证快照仓库 API 将返回连接到快照仓库的节点列表。如果验证失败,API 将返回错误。
如果您使用安全插件,则必须拥有 manage cluster
权限。
端点
GET _snapshot/<repository>/
路径参数
路径参数是可选的。
参数 | 数据类型 | 描述 |
---|---|---|
repository | 字符串 | 要验证的仓库名称。 |
查询参数
参数 | 数据类型 | 描述 |
---|---|---|
cluster_manager_timeout | 时间 | 等待连接到集群管理器节点的时间。可选,默认为 30s 。 |
timeout | 时间 | 等待响应的时间。如果在超时值之前未收到响应,请求将失败并返回错误。默认为 30s 。 |
请求示例
以下请求验证 my-opensearch-repo 是否正常运行
POST /_snapshot/my-opensearch-repo/_verify?timeout=0s&cluster_manager_timeout=50s
示例响应
以下示例与 示例请求 部分中的上述请求相对应。
请求 POST /_snapshot/my-opensearch-repo/_verify?timeout=0s&cluster_manager_timeout=50s
返回以下字段
{
"nodes" : {
"by1kztwTRoeCyg4iGU5Y8A" : {
"name" : "opensearch-node1"
}
}
}
在前面的示例中,一个节点连接到快照仓库。如果有更多节点连接,您将在响应中看到它们。示例
{
"nodes" : {
"lcfL6jv2jo6sMEtp4idMvg" : {
"name" : "node-1"
},
"rEPtFT/B+cuuOHnQn0jy4s" : {
"name" : "node-2"
}
}
响应正文字段
字段 | 数据类型 | 描述 |
---|---|---|
节点 | 对象 | 连接到快照仓库的节点列表(非数组)。每个节点本身都是一个属性,其中节点 ID 是键,名称包含一个 ID(对象)和一个名称(字符串)。 |