Aliases - Get

服務:
Search Service
API 版本:
2026-04-01

擷取別名定義。

GET {endpoint}/aliases('{aliasName}')?api-version=2026-04-01

URI 參數

名稱 位於 必要 類型 Description
aliasName
 path True

string

別名的名稱。
endpoint
 path True

string (uri)

搜尋服務的端點 URL。
api-version
 query True

string

minLength: 1

用於此作業的 API 版本。

要求標頭

名稱 必要 類型 Description
Accept

Accept

接受標頭。
x-ms-client-request-id

string (uuid)

一個不透明、全域唯一、由客戶端產生的請求字串識別碼。

回應

名稱 類型 Description
200 OK

SearchAlias

要求已成功。
Other Status Codes

ErrorResponse

未預期的錯誤回應。

安全性

api-key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

範圍

名稱 Description
https://search.azure.com/.default

範例

SearchServiceGetAlias

範例要求

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

範例回覆

狀態碼:
200 
{
  "name": "myalias",
  "indexes": [
    "example-index"
  ]
}

定義

名稱 Description
Accept

接受標頭。
ErrorAdditionalInfo

資源管理錯誤附加資訊。
ErrorDetail

錯誤詳細資料。
ErrorResponse

所有 Azure Resource Manager API 的常見錯誤回應，用於回傳失敗操作的錯誤細節。 （這也遵循 OData 錯誤回應格式。）。
SearchAlias

表示索引別名，描述從別名名稱到索引的對應。 別名名稱可用來取代支援作業的索引名稱。

Accept

列舉型別

接受標頭。

值 Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱 類型 Description
info

附加資訊。
type

string

其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤附加資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳情
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

Object

所有 Azure Resource Manager API 的常見錯誤回應，用於回傳失敗操作的錯誤細節。 （這也遵循 OData 錯誤回應格式。）。

名稱 類型 Description
error

ErrorDetail

錯誤物件。

SearchAlias

Object

表示索引別名，描述從別名名稱到索引的對應。 別名名稱可用來取代支援作業的索引名稱。

名稱 類型 Description
@odata.etag

string

別名的 ETag。
indexes

string[]

此別名對應至的索引名稱。 只能指定一個索引名稱。
name

string

別名的名稱。