Aliases - Get

Szolgáltatás:: Search Service

API-verzió:: 2023-10-01-Preview

Aliasdefiníciót kér le.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
aliasName	path	True	string	A lekérendő alias neve.
endpoint	path	True	string	A keresési szolgáltatás végponti URL-címe.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A kéréssel együtt küldött nyomkövetési azonosító, amely segít a hibakeresésben.

Válaszok

Name	Típus	Description
200 OK	SearchAlias
Other Status Codes	SearchError	Hibaválasz.

Példák

SearchServiceGetAlias

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 200

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

Definíciók

Name	Description
SearchAlias	Egy index aliasát jelöli, amely az alias nevéből az indexbe való leképezést írja le. Az aliasnév a támogatott műveletek indexneve helyett használható.
SearchError	Az API hibafeltételét ismerteti.

SearchAlias

Tárgy

Egy index aliasát jelöli, amely az alias nevéből az indexbe való leképezést írja le. Az aliasnév a támogatott műveletek indexneve helyett használható.

Name	Típus	Description
@odata.etag	string	Az alias ETagje.
indexes	string[]	Annak az indexnek a neve, amelybe az alias megfelel. Csak egy indexnév adható meg.
name	string	Az alias neve.

SearchError

Tárgy

Az API hibafeltételét ismerteti.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	SearchError[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
message	string	A hiba ember által olvasható ábrázolása.