Aliases - Create Or Update

Služba:
Search Service
Verze rozhraní API:
2023-10-01-Preview

Vytvoří nový alias vyhledávání nebo aktualizuje alias, pokud už existuje.

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

Parametry identifikátoru URI

Název V Vyžadováno Typ Description
aliasName
 path True

string

Definice aliasu pro vytvoření nebo aktualizaci
endpoint
 path True

string

Adresa URL koncového bodu vyhledávací služby.
api-version
 query True

string

Verze rozhraní API klienta.

Hlavička požadavku

Název Vyžadováno Typ Description
x-ms-client-request-id

string (uuid)

ID sledování odeslané s požadavkem, které vám pomůže s laděním.
If-Match

string

Definuje podmínku If-Match. Operace bude provedena pouze v případě, že značky ETag na serveru odpovídají této hodnotě.
If-None-Match

string

Definuje podmínku If-None-Match. Operace bude provedena pouze v případě, že značky ETag na serveru neodpovídají této hodnotě.
Prefer True

string

U požadavků HTTP PUT dává službě pokyn k vrácení vytvořeného nebo aktualizovaného prostředku při úspěchu.

Text požadavku

Název Vyžadováno Typ Description
indexes True

string[]

Název indexu, na který se tento alias mapuje. Je možné zadat pouze jeden název indexu.
name True

string

Název aliasu.
@odata.etag

string

ETag aliasu.

Odpovědi

Název Typ Description
200 OK

SearchAlias

201 Created

SearchAlias

Other Status Codes

SearchError

Chybová odpověď.

Příklady

SearchServiceCreateOrUpdateAlias

Ukázkový požadavek

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


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

Ukázková odpověď

Stavový kód:
200 
{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}
Stavový kód:
201 
{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

Definice

Název Description
SearchAlias

Představuje alias indexu, který popisuje mapování z názvu aliasu na index. Název aliasu lze použít místo názvu indexu pro podporované operace.
SearchError

Popisuje chybový stav rozhraní API.

SearchAlias

Objekt

Představuje alias indexu, který popisuje mapování z názvu aliasu na index. Název aliasu lze použít místo názvu indexu pro podporované operace.

Název Typ Description
@odata.etag

string

ETag aliasu.
indexes

string[]

Název indexu, na který se tento alias mapuje. Je možné zadat pouze jeden název indexu.
name

string

Název aliasu.

SearchError

Objekt

Popisuje chybový stav rozhraní API.

Název Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.
details

SearchError[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message

string

Čitelné znázornění chyby člověkem.