Indexers - Reset Docs

Служба:: Search Service

Версия API:: 2025-11-01-preview

Сбрасывает определенные документы в источнике данных для выборочного повторного приема индексатором.

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2025-11-01-preview

С использованием необязательных параметров:

POST {endpoint}/indexers('{indexerName}')/search.resetdocs?api-version=2025-11-01-preview&overwrite={overwrite}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	URL-адрес конечной точки службы поиска.
indexerName	path	True	string	Имя индексатора.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
overwrite	query		boolean	Если false, ключи или идентификаторы будут добавлены к существующим. Если значение равно true, только ключи или идентификаторы в этих полезных данных будут поставлены в очередь для повторного приема.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Accept		Accept	Заголовок Accept.
x-ms-client-request-id		string (uuid)	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Текст запроса

Имя	Тип	Описание
datasourceDocumentIds	string[]	Идентификаторы документов источника данных, подлежащие сбросу
documentKeys	string[]	ключи документа, которые необходимо сбросить

Ответы

Имя	Тип	Описание
204 No Content		Для этого запроса нет содержимого, но заголовки могут быть полезны.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://search.azure.com/.default

Примеры

SearchServiceResetDocs

Образец запроса

HTTP

POST https://previewexampleservice.search.windows.net/indexers('myindexer')/search.resetdocs?api-version=2025-11-01-preview&overwrite=True


{
  "documentKeys": [
    "1",
    "2",
    "3"
  ]
}

Пример ответа

Код состояния:: 204

Определения

Имя	Описание
Accept	Заголовок Accept.
DocumentKeysOrIds	Тип ключей или идентификаторов.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Accept

Перечисление

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=minimal

DocumentKeysOrIds

Объект

Тип ключей или идентификаторов.

Имя	Тип	Описание
datasourceDocumentIds	string[]	Идентификаторы документов источника данных, подлежащие сбросу
documentKeys	string[]	ключи документа, которые необходимо сбросить

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info		Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Цель ошибки.

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.