Aliases - List

列出搜尋服務可用的所有別名。

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

URI 參數

名稱	位於	必要	類型	Description
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	ListAliasesResult	要求已成功。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

類型: apiKey
位於: header

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

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

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

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

名稱	Description
Accept	接受標頭。
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	所有 Azure Resource Manager API 的常見錯誤回應，用於回傳失敗操作的錯誤細節。（這也遵循 OData 錯誤回應格式。）。
ListAliasesResult	來自「清單別名」要求的回應。如果成功，它會包含所有別名的相關聯索引對映。
SearchAlias	表示索引別名，描述從別名名稱到索引的對應。別名名稱可用來取代支援作業的索引名稱。

列舉型別

接受標頭。

值	Description
application/json;odata.metadata=minimal

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info		附加資訊。
type	string	其他資訊類型。

Object

錯誤詳細資料。

Object

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

名稱	類型	Description
error	ErrorDetail	錯誤物件。

Object

來自「清單別名」要求的回應。如果成功，它會包含所有別名的相關聯索引對映。

名稱	類型	Description
value	SearchAlias[]	Search Service 中的別名。

Object

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