Aliases - Get

服務:

Search Service

API 版本:

2023-10-01-Preview

擷取別名定義。

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

URI 參數

名稱	位於	必要	類型	Description
aliasName	path	True	string	要擷取的別名名稱。
endpoint	path	True	string	搜尋服務的端點 URL。
api-version	query	True	string	用戶端 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	與要求一起傳送的追蹤標識碼，以協助偵錯。

回應

名稱	類型	Description
200 OK	SearchAlias
Other Status Codes	SearchError	錯誤回應。

範例

SearchServiceGetAlias

範例要求

HTTP

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

範例回覆

狀態碼:

200

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

定義

名稱	Description
SearchAlias	表示索引別名，描述從別名名稱到索引的對應。 別名名稱可用來取代支援作業的索引名稱。
SearchError	描述 API 的錯誤狀況。

SearchAlias

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

名稱	類型	Description
@odata.etag	string	別名的 ETag。
indexes	string[]	這個別名所對應的索引名稱。 只能指定一個索引名稱。
name	string	別名的名稱。

SearchError

描述 API 的錯誤狀況。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	SearchError[]	導致此錯誤之特定錯誤的詳細數據陣列。
message	string	人類看得懂的錯誤表示法。