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

Documents - Get

从索引中检索文档。

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2026-04-01

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	搜索服务的终结点 URL。
indexName	path	True	string	索引的名称。
key	path	True	string	要检索的文档的密钥。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。
$select	query		string[]	要检索文档的字段名称列表;未检索的任何字段都将从返回的文档中缺失。

名称	必需	类型	说明
Accept		Accept	接受（Accept）首部。
x-ms-client-request-id		string (uuid)	请求的不透明、全局唯一的客户端生成的字符串标识符。

名称	类型	说明
200 OK	LookupDocument	请求已成功。
Other Status Codes	ErrorResponse	意外的错误响应。

类型: apiKey
在: header

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

名称	说明
https://search.azure.com/.default

GET https://exampleservice.search.windows.net/indexes('example-index')/docs('1')?api-version=2026-04-01&$select=id,description,name,category,ownerId

{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

名称	说明
Accept	接受（Accept）首部。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	所有 Azure 资源管理器 API 的通用错误响应，用于返回失败操作的错误细节。（这也遵循 OData 错误响应格式）。

枚举

接受（Accept）首部。

值	说明
application/json;odata.metadata=none

对象

资源管理错误附加信息。

名称	类型	说明
info		附加信息。
type	string	附加信息类型。

对象

错误详细信息。

对象

所有 Azure 资源管理器 API 的通用错误响应，用于返回失败操作的错误细节。（这也遵循 OData 错误响应格式）。

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