你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Azure AI Search REST API 支持一组常见的 HTTP 请求/响应头，以下为参考摘要：
| 请求标头 | 类型 | Description |
|---|---|---|
| 接受 | 内容类型 | 回复中请求的内容类型。 默认是application/json;odata.metadata=minimal. 其他允许的值有application/json、application/json;odata.metadata=full， application/json;odata.metadata=none，以及仅对$count的text/plain。 |
| API密钥 | String | 根据API设置查询 或管理员密钥。 |
| 授权 | String | 请求的OAuth 2.0访问令牌。 需要配置搜索服务以实现 基于角色的访问。 该请求头适用于使用 Microsoft Entra ID 认证和角色分配的客户端应用。 你的客户端代码必须提供令牌。 只要搜索服务配置为 数据平面认证，你可以在任何支持的 REST API 版本中使用这个请求头。 |
| Content-Type | Content-Type | 请求体的内容类型（PUT/POST）。 所有 API 版本都需要 application/json 这个内容类型。 |
| 客户端请求编号 | GUID | 可选的呼叫者指定请求ID，以无装饰如卷括的GUID形式出现（例如，client-request-id： 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0）。 一个由调用者定义的值，用于识别给定的请求。 如果指定了，该值会包含在响应信息中，作为映射请求的方式。 |
| OData-MaxVersion | "4.0" | 指定客户端支持的最大OData协议版本。 默认是“4.0” |
| 偏好 | “return=表示”或“return=最小” | 用于控制 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方法结合使用，以实现 乐观并发控制。 |
| 响应标头 | 类型 | Description |
|---|---|---|
| 客户端请求编号 | GUID | 如果存在，则是调用者在原始请求中指定的标识符。 |
| Content-Type | Content-Type | 响应内容的类型。 |
| 位置 | URL | POST 和 PUT /indexes 请求新创建的索引定义的 URL。 |
| OData-Version | "4.0" | OData协议版本的回复。 |
| 请求标识 | GUID | 当前作的唯一标识符。 如指定，等于 client-request-id;否则，值将在服务器上生成。 |
| 经过时间 | 编号 | 服务处理请求的时间，以毫秒计。 该值仅包含处理请求所花费的时间，不包括网络传输时间。 |
| ETag | String | 一个不透明字符串，表示当前资源版本（索引器、索引器和数据源返回，文档则不返回）。 在 If-Match 或 If-None-Match 头中使用该字符串以实现 乐观并发控制。 |