你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
获取别名 (预览版 REST API)
适用于：2023-07-01-Preview、2021-04-30-Preview
重要
2023-07-01-预览版 () 无更改。
2021-04-30-Preview 添加了 API。
“获取别名”操作从 Azure AI 搜索获取别名定义。
GET https://[service name].search.windows.net/aliases/[alias name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI 参数
| 参数 | 说明 |
|---|---|
| 服务名称 | 必需。 将其设置为搜索服务的唯一用户定义名称。 |
| 别名 | 必需。 请求 URI 指定要更新的别名的名称。 |
| api-version | 必需。 当前预览版本为 2023-07-01-Preview。 有关更多 版本，请参阅 API 版本。 |
请求标头
下表介绍必需和可选的请求标头。
| 字段 | 说明 |
|---|---|
| Content-Type | 必需。 将其设置为 application/json |
| api-key | 如果使用的是 Azure 角色 ，并且请求中提供了持有者令牌，则为可选，否则需要密钥。 api-key 是系统生成的唯一字符串，用于对搜索服务的请求进行身份验证。 针对搜索服务的获取请求必须包含 api-key 设置为管理密钥 (的标头，而不是) 查询密钥。 有关详细信息 ，请参阅使用密钥身份验证连接到 Azure AI 搜索 。 |
请求正文
无。
响应
对于成功的响应，返回“状态代码：200 正常”。
响应正文将类似于以下示例。
{
"name" : "my-alias",
"indexes" : ["my-index"]
}