你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Azure AI 搜索) (常见 HTTP 请求和响应标头
Azure AI 搜索 REST API 支持一组常见的 HTTP 请求/响应标头，此处汇总供参考：
| 请求头 | 类型 | 说明 |
|---|---|---|
| 接受 | 内容类型 | 响应的请求内容类型。 默认值为 application/json;odata.metadata=minimal。 其他允许的值包括 application/json、application/json;odata.metadata=full， application/json;odata.metadata=none，且仅) $count的文本/纯 (。 |
| api-key | String | 将 设置为 查询或管理密钥，具体取决于 API。 |
| authorization | String | 请求的 OAuth 2.0 访问令牌。 需要配置搜索服务才能 进行基于角色的访问。 此请求标头适用于使用Microsoft Entra ID身份验证和角色分配的客户端应用。 客户端代码必须提供令牌。 只要为 数据平面身份验证配置了搜索服务，就可以将此请求标头与任何受支持的 REST API 版本一起使用。 |
| Content-Type | Content-Type | 请求正文的内容类型 (PUT/POST)。 默认为 application/json。 |
| client-request-id | GUID | 可选的调用方指定的请求 ID，采用不带修饰的 GUID 形式，如大括号 (例如 client-request-id：9C4D50EE-2D56-4CD3-8152-34347DC9F2B0) 。 调用方定义的值，用于标识给定请求。 如果指定，此值将包含在响应信息中，作为映射请求的一种方式。 |
| OData-MaxVersion | "4.0" | 指定客户端支持的最高 OData 协议版本。 默认值为“4.0”。 |
| Prefer | “return=representation”或“return=minimal” | 用于控制来自 PUT 和 POST /indexes 请求的响应负载。 通过 POST 或 PUT 创建新索引时，默认值为“return=representation”，通过 PUT 更新现有索引时默认为“return=minimal”。 |
| return-client-request-id | 是或否 | 如果在指定 client-request-id 的情况下指定该标头，则会指示服务器在响应中包含 client-request-id 标头。 默认值为 False。 |
| If-Match | ETag 或 * | 仅当当前版本与指定的 ETag 匹配时，才用于更改资源。 将此标头与 POST、PUT 或 DELETE 方法一起使用， (资源（例如索引器、索引和数据源），但不能) 文档启用 乐观并发控制。 |
| If-None-Match | ETag 或 * | 仅当当前版本与指定的 ETag 不匹配时，才用于更改资源。 将此标头与 POST、PUT 或 DELETE 方法一起使用， (资源（例如索引器、索引和数据源），但不能) 文档启用 乐观并发控制。 |
| 响应标头 | 类型 | 说明 |
|---|---|---|
| client-request-id | GUID | 调用方在原始请求（如果存在）中指定的标识符。 |
| Content-Type | Content-Type | 响应正文的内容类型。 |
| 位置 | 代码 | 为 POST 和 PUT /indexes 请求新建的索引定义的 URL。 |
| OData-Version | "4.0" | 响应的 OData 协议版本。 |
| request-id | GUID | 当前操作的唯一标识符。 等于 client-request-id（如果已指定）；否则在服务器上生成值。 |
| elapsed-time | Number | 服务处理请求所花费的时间，以毫秒为单位。 此值仅包括处理请求所用的时间，不包括网络传输时间。 |
| ETag | String | 一个不透明的字符串，表示当前版本的资源 (为索引器、索引和数据源返回，而不是) 文档。 在 If-Match 或 If-None-Match 标头中使用此字符串进行 乐观并发控制。 |