Aliases - Get

Načte definici aliasu.

GET {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	Název aliasu, který se má načíst.
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
api-version	query	True	string	Verze rozhraní API klienta.

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.

Název	Typ	Description
200 OK	SearchAlias
Other Status Codes	SearchError	Chybová odpověď.

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

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

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.

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.

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.