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

Documents - Get

从索引中检索文档。

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2024-05-01-preview

具有可选参数:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2024-05-01-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	搜索服务的终结点 URL。
indexName	path	True	string	索引的名称。
key	path	True	string	要检索的文档的键。
api-version	query	True	string	客户端 API 版本。
$select	query		string[]	要检索文档的字段名称列表;未检索的任何字段都将从返回的文档中缺失。

名称	必需	类型	说明
x-ms-client-request-id		string (uuid)	随请求一起发送的跟踪 ID，以帮助进行调试。

名称	类型	说明
200 OK	LookupDocument	包含请求的文档的响应。
Other Status Codes	ErrorResponse	错误响应。

GET https://myservice.search.windows.net/indexes('myindex')/docs('1')?$select=docId,title,description&api-version=2024-05-01-preview

{
  "description": "Cheapest hotel in town",
  "docId": "1",
  "title": "Nice Hotel"
}

对象

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

对象

错误详细信息。

对象

错误响应

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