---
title: "查询仓库（Cat格式）"
date: 2026-02-21
lastmod: 2026-02-21
description: "以表格形式查询快照仓库"
tags: ["快照仓库", "查询", "Cat API"]
summary: "以紧凑的表格形式返回集群中注册的快照仓库信息。
API 格式 #  GET /_cat/repositories API 作用 #  该 API 以表格形式返回快照仓库信息：
 显示所有已注册的快照仓库 显示仓库 ID 和类型 快速查看仓库配置概况  API 参数 #  查询参数 #     参数 类型 是否必填 默认值 描述     format String 否 文本表格 响应格式（如 json、yaml）   h String 否 所有列 逗号分隔的列名列表，指定要显示的列   help Boolean 否 false 是否返回帮助信息   s String 否 - 逗号分隔的列名或别名，用于排序   v Boolean 否 false 是否显示列标题（详细模式）   local Boolean 否 false 是否仅返回本地信息   master_timeout Time 否 集群默认 连接主节点的超时时间    响应列说明 #     列名 别名 描述     id repoId 唯一的仓库 ID   type t 仓库类型    请求示例 #  查询所有仓库 #  GET /_cat/repositories?"
---


以紧凑的表格形式返回集群中注册的快照仓库信息。

## API 格式

```
GET /_cat/repositories
```

## API 作用

该 API 以表格形式返回快照仓库信息：
- 显示所有已注册的快照仓库
- 显示仓库 ID 和类型
- 快速查看仓库配置概况

## API 参数

### 查询参数

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
|------|------|----------|--------|------|
| `format` | String | 否 | 文本表格 | 响应格式（如 `json`、`yaml`） |
| `h` | String | 否 | 所有列 | 逗号分隔的列名列表，指定要显示的列 |
| `help` | Boolean | 否 | `false` | 是否返回帮助信息 |
| `s` | String | 否 | - | 逗号分隔的列名或别名，用于排序 |
| `v` | Boolean | 否 | `false` | 是否显示列标题（详细模式） |
| `local` | Boolean | 否 | `false` | 是否仅返回本地信息 |
| `master_timeout` | Time | 否 | 集群默认 | 连接主节点的超时时间 |

## 响应列说明

| 列名 | 别名 | 描述 |
|------|------|------|
| `id` | `repoId` | 唯一的仓库 ID |
| `type` | `t` | 仓库类型 |

## 请求示例

### 查询所有仓库

```
GET /_cat/repositories?v
```

### JSON 格式响应

```
GET /_cat/repositories?format=json
```

## 响应示例

### 文本表格格式（verbose 模式）

```
id   | type
-----+-------
fs   | fs
s3   | s3
azure| azure
```

### JSON 格式响应

```json
[
  {
    "id": "fs",
    "type": "fs"
  },
  {
    "id": "s3",
    "type": "s3"
  },
  {
    "id": "azure",
    "type": "azure"
  }
]
```

## 仓库类型说明

| 类型 | 描述 |
|------|------|
| `fs` | 文件系统仓库（本地或共享文件系统） |
| `s3` | AWS S3 仓库 |
| `azure` | Azure Storage 仓库 |
| `gcs` | Google Cloud Storage 仓库 |
| `hdfs` | HDFS 仓库 |
| `url` | URL 仓库（只读） |

## 使用场景

1. **快速查看**：快速查看所有已配置的仓库
2. **类型验证**：确认仓库类型配置
3. **配置检查**：验证仓库是否正确注册

## 注意事项

1. **v 参数**：使用 `?v` 显示列标题
2. **简化输出**：此 API 仅显示仓库名称和类型
3. **详细信息**：使用 GET /_snapshot/{repository} 获取完整仓库配置

## 相关操作

- **GET /_snapshot/{repository}**：获取详细仓库信息
- **PUT /_snapshot/{repository}**：创建仓库
- **DELETE /_snapshot/{repository}**：删除仓库
- **POST /_snapshot/{repository}/_verify**：验证仓库
- **GET /_cat/snapshots**：查询快照信息

## 实现文件

- **REST 处理器**：`RestRepositoriesAction.java`
- **仓库元数据**：`RepositoryMetadata.java`
- **API 规范**：`cat.repositories.json`
- **基础类**：`AbstractCatAction.java`