Aliases - Get

Služba:: Search Service

Verze rozhraní API:: 2026-08-01-preview

Načte definici aliasu.

GET {endpoint}/aliases('{aliasName}')?api-version=2026-08-01-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
aliasName	path	True	string	Název aliasu.
endpoint	path	True	string (uri)	Adresa URL koncového bodu vyhledávací služby.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Accept		Accept	Hlavička Accept.
x-ms-client-request-id		string (uuid)	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Odpovědi

Name	Typ	Description
200 OK	SearchAlias	Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

Name	Description
https://search.azure.com/.default

Příklady

SearchServiceGetAlias

Ukázkový požadavek

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/aliases('myalias')?api-version=2026-08-01-preview

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
Accept	Hlavička Accept.
ErrorAdditionalInfo	Další informace o chybě při správě prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
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.

Accept

Výčet

Hlavička Accept.

Hodnota	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Další informace o chybě při správě prostředků

Name	Typ	Description
info		Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

SearchAlias

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.

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.