Aliases - Get

Szolgáltatás:: Search Service

API-verzió:: 2024-11-01-preview

Aliasdefiníciót kér le.

GET {endpoint}/aliases('{aliasName}')?api-version=2024-11-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	ErrorResponse	Hibaválasz.

Példák

SearchServiceGetAlias

Mintakérelem

HTTP

GET https://previewexampleservice.search.windows.net/aliases('myalias')?api-version=2024-11-01-preview

Mintaválasz

Állapotkód:: 200

{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
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ó.

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

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.