Delete API

Delete API #

按 ID 删除单条文档。

请求格式 #

DELETE /<index>/_doc/<_id>

路径参数 #

参数必需说明
<index>目标索引
<_id>文档 ID

查询参数 #

参数类型默认值说明
routingstring自定义路由值
timeouttime1m等待主分片可用的超时
refreshstringfalse删除后刷新策略
versionlong期望版本号
version_typestringinternal版本类型
if_seq_nolong乐观并发控制
if_primary_termlong乐观并发控制
wait_for_active_shardsstring活跃分片数量

示例 #

DELETE /website/_doc/123

响应:

{
  "_index":   "website",
  "_type":    "_doc",
  "_id":      "123",
  "_version": 2,
  "result":   "deleted"
}

删除后 _version 递增。即使文档被删除后重新写入同一 _id_version 仍会继续递增。


参考导航 #

需求参见
按查询批量删除Delete by Query
写入文档Index API
乐观并发控制并发控制与版本