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

Aliases - List

服务:: Search Service

API 版本:: 2026-04-01

列出可用于搜索服务的所有别名。

GET {endpoint}/aliases?api-version=2026-04-01

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	搜索服务的终结点 URL。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求头

名称	必需	类型	说明
Accept		Accept	接受（Accept）首部。
x-ms-client-request-id		string (uuid)	请求的不透明、全局唯一的客户端生成的字符串标识符。

响应

名称	类型	说明
200 OK	ListAliasesResult	请求已成功。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

api-key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://search.azure.com/.default

示例

SearchServiceListAliases

示例请求

HTTP

GET https://exampleservice.search.windows.net/aliases?api-version=2026-04-01

示例响应

状态代码:: 200

{
  "value": [
    {
      "name": "myalias",
      "indexes": [
        "example-index"
      ]
    }
  ]
}

定义

名称	说明
Accept	接受（Accept）首部。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	所有 Azure 资源管理器 API 的通用错误响应，用于返回失败操作的错误细节。（这也遵循 OData 错误响应格式）。
ListAliasesResult	来自“列出别名”请求的响应。如果成功，它将包括所有别名的关联索引映射。
SearchAlias	表示索引别名，该别名描述从别名到索引的映射。别名可用于代替受支持操作的索引名称。

Accept

枚举

接受（Accept）首部。

值	说明
application/json;odata.metadata=minimal

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info		附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

所有 Azure 资源管理器 API 的通用错误响应，用于返回失败操作的错误细节。（这也遵循 OData 错误响应格式）。

名称	类型	说明
error	ErrorDetail	错误对象。

ListAliasesResult

对象

来自“列出别名”请求的响应。如果成功，它将包括所有别名的关联索引映射。

名称	类型	说明
value	SearchAlias[]	搜索服务中的别名。

SearchAlias

对象

表示索引别名，该别名描述从别名到索引的映射。别名可用于代替受支持操作的索引名称。

名称	类型	说明
@odata.etag	string	别名的 ETag。
indexes	string[]	此别名映射到的索引的名称。只能指定一个索引名称。
name	string	别名的名称。