你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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，则键或 ID 将附加到现有键或 ID 中。如果为 true，则只有此有效负载中的密钥或 ID 将排队等待重新摄取。

请求头

名称	必需	类型	说明
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
流向: 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	所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 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

对象

所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式）。

名称	类型	说明
error	ErrorDetail	错误对象。