Aliases - Create Or Update

服務:

Search Service

API 版本:

2023-10-01-Preview

建立新的搜尋別名，或更新已經存在的別名。

PUT {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	與要求一起傳送的追蹤標識碼，以協助偵錯。
If-Match		string	定義 If-Match 條件。 只有在伺服器上的 ETag 符合此值時，才會執行作業。
If-None-Match		string	定義 If-None-Match 條件。 只有在伺服器上的 ETag 不符合此值時，才會執行作業。
Prefer	True	string	針對 HTTP PUT 要求，指示服務在成功時傳回已建立/更新的資源。

要求本文

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

回應

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

範例

SearchServiceCreateOrUpdateAlias

範例要求

HTTP

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


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

範例回覆

狀態碼:

200

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

狀態碼:

201

{
  "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	人類看得懂的錯誤表示法。