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

(Azure 认知搜索 REST API) 列表索引器

列表索引器操作返回Azure 认知搜索服务中的索引器列表。

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

URI 参数

参数 说明
服务名称 必需。 将其设置为搜索服务的唯一用户定义的名称。
api-version 必需。 当前稳定版本为 api-version=2020-06-30. 有关更多版本,请参阅 API 版本

请求标头

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

字段 说明
Content-Type 必需。 将其设置为 application/json
api-key 必需。 api-key 用于对搜索服务的请求进行身份验证。 它是一个字符串值,对于服务是唯一的。 获取有关服务中的对象的请求必须包含一个 api 密钥字段,该字段设置为管理密钥 (,而不是查询密钥) 。

可以从Azure 门户中的服务仪表板获取 API 密钥值。 有关详细信息,请参阅 查找现有密钥

请求正文

无。

响应

对于成功的请求:“200 正常”。 下面是响应正文示例:

{  
      "value" : [  
      {  
        "name" : "myindexer",  
        "description" : "a cool indexer",  
        "dataSourceName" : "ordersds",  
        "targetIndexName" : "orders",  
        ... other indexer properties  
      }]  
    }  

可以将响应筛选为只筛选感兴趣的属性。 例如,如果只需要索引器名称的列表,请使用 OData $select 查询选项:

GET /indexers?api-version=2020-06-30&$select=name  

在此情况下,来自上述示例的响应将如下所示:

{  
      "value" : [ { "name": "myindexer" } ]  
    }  

如果在搜索服务中有大量索引器,这是节省带宽的有用技术。

注意

如果索引器具有 加密密钥,搜索服务必须有权访问加密密钥,才能在该索引器的定义中检索加密属性。 如果不访问加密密钥, "<encrypted>" 则返回占位符代替加密属性。 还原对密钥的访问允许搜索服务再次检索完整的索引器定义。

另请参阅