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

(Azure AI 搜索 REST API) 获取索引

  • 项目

获取 索引 操作从 Azure AI 搜索获取索引定义。

GET https://[service name].search.windows.net/indexes/[index name]?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

URI 参数

参数 说明
服务名称 必需。 将此设置为搜索服务的唯一用户定义名称。
索引名称 必需。 请求 URI 指定要返回的索引的名称。
api-version 必需。 有关受支持的版本列表，请参阅 API 版本。

请求标头

下表介绍必需和可选的请求标头。

字段 说明
Content-Type 必需。 将其设置为 application/json
api-key 如果使用 Azure 角色 并且请求中提供了持有者令牌，则为可选，否则需要密钥。 如果使用 API 密钥，请指定管理密钥 (而不是查询密钥，) 从搜索服务返回对象信息。 有关详细信息 ，请参阅使用密钥身份验证连接到 Azure AI 搜索 。

请求正文

无。

响应

状态代码：成功响应返回“200 正常”。 有关响应有效负载的示例，请参阅 创建索引 (Azure AI 搜索 REST API) 中的示例请求 JSON。 获取索引响应正文和创建索引响应和响应正文的格式相同。

另请参阅