Sdílet prostřednictvím


Aliases - Get

Načte definici aliasu.

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

Parametry identifikátoru URI

Name 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.

Hlavička požadavku

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

string

uuid

ID sledování odeslané spolu s požadavkem na pomoc s laděním.

Odpovědi

Name Typ Description
200 OK

SearchAlias

Other Status Codes

SearchError

Chybová odpověď.

Příklady

SearchServiceGetAlias

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
SearchAlias

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

SearchError

Popisuje chybovou podmínku rozhraní API.

SearchAlias

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

Name Typ Description
@odata.etag

string

Značka ETag aliasu

indexes

string[]

Název indexu, na který se tento alias mapuje. Může být zadán pouze jeden název indexu.

name

string

Název aliasu.

SearchError

Popisuje chybovou podmínku rozhraní API.

Name Typ Description
code

string

Jeden ze serverem definovaných chybových kódů.

details

SearchError[]

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

message

string

Lidsky čitelná reprezentace chyby.