---
title: "查询所有快照仓库"
date: 2026-03-29
lastmod: 2026-03-29
description: "介绍如何在 Easysearch 中查询所有已注册的快照存储仓库信息。"
tags: ["快照", "仓库", "查询"]
summary: "此 API 用于获取集群中所有已注册的快照存储仓库信息。
API #  GET /_snapshot API 的作用 #  返回集群中所有已注册的快照存储仓库信息。每个仓库包含：
 仓库名称：仓库的唯一标识符 仓库类型：文件系统、S3、HDFS 等 仓库配置：存储位置、压缩设置等  此 API 用于：
 查看集群中可用的备份仓库 验证仓库配置是否正确 获取仓库的详细信息用于备份和恢复操作  API 的参数 #  此 API 没有路由参数。
查询字符串参数 #     参数 类型 是否必需 默认值 描述     master_timeout time 可选 30s 等待主节点响应的超时时间   local boolean 可选 false 是否从本地节点获取信息    请求示例 #  # 查询所有快照仓库 GET /_snapshot # 设置主节点超时时间 GET /_snapshot?"
---


此 API 用于获取集群中所有已注册的快照存储仓库信息。

## API

```
GET /_snapshot
```

## API 的作用

返回集群中所有已注册的快照存储仓库信息。每个仓库包含：

- **仓库名称**：仓库的唯一标识符
- **仓库类型**：文件系统、S3、HDFS 等
- **仓库配置**：存储位置、压缩设置等

此 API 用于：
- 查看集群中可用的备份仓库
- 验证仓库配置是否正确
- 获取仓库的详细信息用于备份和恢复操作

## API 的参数

此 API **没有**路由参数。

### 查询字符串参数

| 参数 | 类型 | 是否必需 | 默认值 | 描述 |
|------|------|----------|--------|------|
| `master_timeout` | time | 可选 | 30s | 等待主节点响应的超时时间 |
| `local` | boolean | 可选 | false | 是否从本地节点获取信息 |

## 请求示例

```bash
# 查询所有快照仓库
GET /_snapshot

# 设置主节点超时时间
GET /_snapshot?master_timeout=60s

# 从本地节点获取信息
GET /_snapshot?local=true
```

## 响应示例

### 成功响应

```json
{
  "my-fs-repo": {
    "type": "fs",
    "settings": {
      "location": "/mount/backups/my_backup"
    }
  },
  "my-s3-repo": {
    "type": "s3",
    "settings": {
      "bucket": "my-backup-bucket",
      "region": "us-west-2",
      "base_path": "easysearch"
    }
  },
  "backup-repo": {
    "type": "fs",
    "settings": {
      "location": "/backup/easysearch",
      "compress": true,
      "max_restore_bytes_per_sec": "50mb",
      "max_snapshot_bytes_per_sec": "100mb"
    }
  }
}
```

### 响应字段说明

| 字段 | 描述 |
|------|------|
| 仓库名（键） | 仓库的唯一标识符 |
| `type` | 仓库类型<br>`fs`：文件系统<br>`s3`：AWS S3<br>`hdfs`：HDFS<br>`azure`：Azure Storage<br>`gcs`：Google Cloud Storage |
| `settings` | 仓库配置对象，包含类型特定的配置 |

## 仓库配置说明

### 文件系统仓库 (fs)

```json
{
  "type": "fs",
  "settings": {
    "location": "/mount/backups/my_backup",
    "compress": true,
    "chunk_size": null,
    "max_restore_bytes_per_sec": "50mb",
    "max_snapshot_bytes_per_sec": "100mb"
  }
}
```

### S3 仓库 (s3)

```json
{
  "type": "s3",
  "settings": {
    "bucket": "my-backup-bucket",
    "region": "us-west-2",
    "base_path": "easysearch"
  }
}
```

## 使用场景

1. **仓库验证**：确认仓库已正确配置
2. **容量规划**：查看已配置的存储位置
3. **问题排查**：诊断仓库相关问题
4. **备份管理**：管理多个备份仓库

## 仓库类型说明

| 类型 | 描述 | 适用场景 |
|------|------|----------|
| `fs` | 共享文件系统 | 本地或 NAS 存储 |
| `s3` | AWS S3 或兼容服务 | 云存储备份 |
| `hdfs` | Hadoop HDFS | 大数据环境 |
| `azure` | Azure Blob Storage | Azure 环境 |
| `gcs` | Google Cloud Storage | GCP 环境 |

## 注意事项

1. 此 API 只支持 GET 方法
2. 返回的是已注册的仓库列表
3. 敏感信息（如密钥）不会在响应中显示
4. `local=true` 时可能返回过时信息
5. 仓库配置可能因插件支持而有所不同

## 最佳实践

1. **定期验证**：定期检查仓库配置
2. **多仓库策略**：配置多个仓库实现备份冗余
3. **权限管理**：确保仓库访问权限正确
4. **监控存储**：监控仓库存储空间使用
5. **文档记录**：记录仓库配置便于维护

## 相关文档

- [创建快照仓库](./create-snapshot-repository.md)
- [查询指定快照仓库](./get-specific-snapshot-repository.md)
- [删除快照仓库](./delete-snapshot-repository.md)
- [查询快照信息](./get-snapshot-info.md)