关闭索引
1.0 版引入
关闭索引 API 操作用于关闭索引。索引一旦关闭,就不能向其中添加数据或搜索其中的任何数据。
端点
POST /<index>/_close
路径参数
参数 | 类型 | 描述 |
---|---|---|
<index> | 字符串 | 要关闭的索引。可以是逗号分隔的多个索引名称列表。使用 _all 或 * 来关闭所有索引。 |
查询参数
所有参数都是可选的。
参数 | 类型 | 描述 |
---|---|---|
allow_no_indices | 布尔型 | 是否忽略不匹配任何索引的通配符。默认值为 true 。 |
expand_wildcards | 字符串 | 将通配符表达式扩展到不同的索引。使用逗号分隔多个值。可用值包括 all(匹配所有索引)、open(匹配开放索引)、closed(匹配已关闭索引)、hidden(匹配隐藏索引)和 none(不接受通配符表达式)。默认值为 open 。 |
ignore_unavailable | 布尔型 | 如果为 true,OpenSearch 不会搜索缺失或已关闭的索引。默认值为 false 。 |
wait_for_active_shards | 字符串 | 指定 OpenSearch 处理请求前必须可用的活动分片数量。默认值为 1(仅主分片)。设置为 all 或正整数。大于 1 的值需要副本。例如,如果指定值为 3,则索引必须在两个额外节点上分布有两个副本,请求才能成功。 |
cluster_manager_timeout | 时间 | 等待连接到集群管理器节点的时间。默认值为 30s 。 |
timeout | 时间 | 等待集群响应的时间。默认值为 30s 。 |
示例请求
POST /sample-index/_close
示例响应
{
"acknowledged": true,
"shards_acknowledged": true,
"indices": {
"sample-index1": {
"closed": true
}
}
}