你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
(Azure AI 搜索 REST API) 列出索引器
列出索引器操作返回 Azure AI 搜索服务中的索引器列表。
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 | 如果使用 Azure 角色 并且请求中提供了持有者令牌,则为可选,否则需要密钥。 api-key 是系统生成的唯一字符串,用于对搜索服务的请求进行身份验证。 获取对象定义的请求必须包括设置为管理密钥 (而不是查询密钥) 的 api-key 字段。 有关详细信息 ,请参阅使用密钥身份验证连接到 Azure AI 搜索 。 |
请求正文
无。
响应
对于成功的请求:“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>"
占位符来代替加密的属性。 还原对密钥的访问允许搜索服务再次检索完整的索引器定义。