---
title: "查询指定快照仓库"
date: 2026-03-27
lastmod: 2026-03-27
description: "介绍如何在 Easysearch 中查询指定快照存储仓库的详细信息。"
tags: ["快照", "仓库", "查询"]
summary: "此 API 用于获取集群中指定快照存储仓库的信息。
API #  GET /_snapshot/{repository} API 的作用 #  返回指定快照存储仓库的详细配置信息。可以查看：
 仓库类型：文件系统、S3、HDFS 等 存储配置：位置、端点、存储桶等 性能设置：带宽限制、压缩设置等  此 API 用于验证特定仓库的配置是否正确。
API 的参数 #  路由参数 #     参数 类型 是否必需 描述     repository string 必需 仓库名称    查询字符串参数 #     参数 类型 是否必需 默认值 描述     master_timeout time 可选 30s 等待主节点响应的超时时间   local boolean 可选 false 是否从本地节点获取信息    请求示例 #  # 查询指定仓库 GET /_snapshot/my-fs-repo # 设置主节点超时时间 GET /_snapshot/my-fs-repo?"
---


此 API 用于获取集群中指定快照存储仓库的信息。

## API

```
GET /_snapshot/{repository}
```

## API 的作用

返回指定快照存储仓库的详细配置信息。可以查看：

- **仓库类型**：文件系统、S3、HDFS 等
- **存储配置**：位置、端点、存储桶等
- **性能设置**：带宽限制、压缩设置等

此 API 用于验证特定仓库的配置是否正确。

## API 的参数

### 路由参数

| 参数 | 类型 | 是否必需 | 描述 |
|------|------|----------|------|
| `repository` | string | 必需 | 仓库名称 |

### 查询字符串参数

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

## 请求示例

```bash
# 查询指定仓库
GET /_snapshot/my-fs-repo

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

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

## 响应示例

### 成功响应 - 文件系统仓库

```json
{
  "my-fs-repo": {
    "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",
      "readonly": false
    }
  }
}
```

### 成功响应 - S3 仓库

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

### 错误响应 - 仓库不存在

```json
{
  "error": {
    "root_cause": [
      {
        "type": "repository_missing_exception",
        "reason": "[my-repo] missing"
      }
    ],
    "type": "repository_missing_exception",
    "reason": "[my-repo] missing"
  },
  "status": 404
}
```

## 响应字段说明

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

### 文件系统仓库配置

| 字段 | 描述 |
|------|------|
| `location` | 共享文件系统的路径 |
| `compress` | 是否压缩快照文件 |
| `chunk_size` | 快照文件的块大小 |
| `max_restore_bytes_per_sec` | 恢复时的最大字节数/秒 |
| `max_snapshot_bytes_per_sec` | 创建快照时的最大字节数/秒 |
| `readonly` | 是否只读模式 |

### S3 仓库配置

| 字段 | 描述 |
|------|------|
| `bucket` | S3 存储桶名称 |
| `region` | AWS 区域 |
| `base_path` | 存储桶中的基础路径 |
| `endpoint` | S3 兼容服务的端点（如使用） |

## 使用场景

1. **配置验证**：验证仓库配置是否正确
2. **问题排查**：诊断仓库相关问题
3. **信息查询**：获取仓库的详细配置
4. **容量评估**：查看仓库的带宽限制设置

## 注意事项

1. 此 API 只支持 GET 方法
2. 敏感信息（如密钥）不会在响应中显示
3. `local=true` 时可能返回过时信息
4. 仓库不存在时返回 404 错误

## 相关文档

- [创建快照仓库](./create-snapshot-repository.md)
- [查询所有快照仓库](./get-all-snapshot-repositories.md)
- [删除快照仓库](./delete-snapshot-repository.md)
- [验证快照仓库](./verify-snapshot-repository.md)