DELETE - это API OpenSearch, который удаляет документ из определенного индекса. Для удаления документа этому API требуется имя индекса и _id документа.
Удаление документа
| 1 | DELETE /my_index/_doc/1 |
Параметры URL
| Параметр | Тип | Описание | Требуется |
| <index> | String | Индекс, с которого производится удаление. | Да |
| <_id> | String | Идентификатор удаляемого документа. | Да |
| if_seq_no | Integer | Операция удаления выполняется только в том случае, если номер версии документа совпадает с указанным номером. | Нет |
| if_primary_term | Integer | Операция удаления выполняется только в том случае, если документ имеет указанный первичный термин. | Нет |
| refresh | Enum | Если опция true, OpenSearch обновляет шарды, чтобы операция удаления стала доступна в результатах поиска. Возможные опции: true, false и wait_for, что указывает OpenSearch на необходимость дождаться обновления перед выполнением операции. По умолчанию используется значение false. | Нет |
| routing | String | Значение, используемое для маршрутизации операции на определенный шард. | Нет |
| timeout | Time | Сколько времени ждать ответа от кластера. По умолчанию 1 м. | Нет |
| version | Integer | Версия удаляемого документа, которая должна совпадать с последней обновленной версией документа. | Нет |
| version_type | Enum | Извлечение конкретно заданного документа. Доступны следующие варианты: external (получение документа, если указанный номер версии больше текущей версии документа) и external_gte (получение документа, если указанный номер версии больше или равен текущей версии документа). Например, для удаления третьей версии документа используйте команду /_doc/1?version=3&version_type=external. | Нет |
| wait_for_active_shards | String | Количество активных шардов, которые должны быть доступны до того, как OpenSearch обработает запрос на удаление. По умолчанию 1 (только основной шард). Устанавливается в значение all или целое положительное число. Значения, превышающие 1, требуют наличия реплик. Например, если указать значение 3, то для успешного выполнения операции индекс должен иметь две реплики, распределенные по двум дополнительным узлам. | Нет |
Поля тела ответа
| Поле | Описание |
| _index | Имя индекса. |
| _id | Идентификатор документа. |
| _version | Версия документа. |
| _result | Результат операции удаления. |
| _shards | Подробная информация о шардах кластера. |
| total | Общее количество шардов. |
| successful | Количество шардов, с которых OpenSearch успешно удалил документ. |
| failed | Количество шардов, с которых OpenSearch не смог удалить документ. |
| _seq_no | Порядковый номер, присвоенный документу при индексировании. |
Примечания
- Запрос на удаление выдает код ошибки 404, если документ еще не существует в индексе.
- Если требуется удалить набор документов, соответствующих запросу, необходимо использовать API delete by query.
