Aliases - List

Szolgáltatás:: Search Service

API-verzió:: 2026-04-01

A keresési szolgáltatáshoz elérhető összes alias listája.

GET {endpoint}/aliases?api-version=2026-04-01

URI-paraméterek

Név	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A keresési szolgáltatás végpontjának URL-címe.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Név	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.
Accept		Accept	Az Elfogadás fejléce.

Válaszok

Név	Típus	Description
200 OK	ListAliasesResult	A kérés sikeres volt.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

api-key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Hatókörök

Név	Description
https://search.azure.com/.default

Példák

SearchServiceListAliases

Mintakérelem

HTTP

GET https://exampleservice.search.windows.net/aliases?api-version=2026-04-01

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "name": "myalias",
      "indexes": [
        "example-index"
      ]
    }
  ]
}

Definíciók

Név	Description
Accept	Az Elfogadás fejléce.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
ListAliasesResult	Válasz egy List Aliases kérésre. Ha sikeres, tartalmazza az összes alias társított indexleképezését.
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ó.

Accept

Felsorolás

Az Elfogadás fejléce.

Érték	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Tárgy

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

Név	Típus	Description
info		A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Név	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 hiba célpontja.

ErrorResponse

Tárgy

Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Név	Típus	Description
error	ErrorDetail	A hibaobjektum.

ListAliasesResult

Tárgy

Válasz egy List Aliases kérésre. Ha sikeres, tartalmazza az összes alias társított indexleképezését.

Név	Típus	Description
value	SearchAlias[]	Az aliasok a Keresés szolgáltatásban.

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

Név	Típus	Description
@odata.etag	string	Az álnév ETag-je.
indexes	string[]	Annak az indexnek a neve, amelyre az alias leképezhető. Csak egy indexnév adható meg.
name	string	Az alias neve.