你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
(Azure AI 搜索 REST API) 列出索引
“列出索引”操作返回 Azure AI 搜索服务中当前索引的列表。
GET https://[service name].search.windows.net/indexes?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 密钥字段。 有关详细信息 ，请参阅使用密钥身份验证连接到 Azure AI 搜索 。 |
请求正文
无。
响应
成功响应时返回状态代码：“200 正常”。
示例
{
"value": [
{
"name": "Books",
"fields": [
{"name": "ISBN", ...},
...
]
},
{
"name": "Games",
...
},
...
]
}
可以将响应筛选为只筛选出你感兴趣的属性。 例如，如果只需要索引名称的列表，请使用 OData $select 查询选项：
GET /indexes?api-version=2020-06-30&$select=name
在此情况下，来自上述示例的响应将如下所示：
{
"value": [
{"name": "Books"},
{"name": "Games"},
...
]
}
如果在搜索服务中有大量索引，这是节省带宽的有用技术。