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

Aliases - Get

服务:
Search Service
API 版本:
2023-10-01-Preview

检索别名定义。

GET {endpoint}/aliases('{aliasName}')?api-version=2023-10-01-Preview

URI 参数

名称 在 必需 类型 说明
aliasName
 path True

string

要检索的别名的名称。
endpoint
 path True

string

搜索服务的终结点 URL。
api-version
 query True

string

客户端 API 版本。

请求头

名称 必需 类型 说明
x-ms-client-request-id

string (uuid)

随请求一起发送的跟踪 ID，以帮助进行调试。

响应

名称 类型 说明
200 OK

SearchAlias

Other Status Codes

SearchError

错误响应。

示例

SearchServiceGetAlias

示例请求

GET https://myservice.search.windows.net/aliases('production')?api-version=2023-10-01-Preview

示例响应

状态代码:
200 
{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

定义

名称 说明
SearchAlias

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

描述 API 的错误条件。

SearchAlias

对象

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

名称 类型 说明
@odata.etag

string

别名的 ETag。
indexes

string[]

此别名映射到的索引的名称。 只能指定一个索引名称。
name

string

别名的名称。

SearchError

对象

描述 API 的错误条件。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
details

SearchError[]

导致此报告错误的特定错误的详细信息数组。
message

string

错误的人工可读表示形式。