Aliases - Get

Usługa:: Search Service

Wersja interfejsu API:: 2025-03-01-preview

Pobiera definicję aliasu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
aliasName	path	True	string	Nazwa aliasu do pobrania.
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Identyfikator śledzenia wysłany z żądaniem, aby ułatwić debugowanie.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SearchAlias
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchServiceGetAlias

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
SearchAlias	Reprezentuje alias indeksu, który opisuje mapowanie z nazwy aliasu na indeks. Nazwa aliasu może być używana zamiast nazwy indeksu dla obsługiwanych operacji.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

SearchAlias

Objekt

Reprezentuje alias indeksu, który opisuje mapowanie z nazwy aliasu na indeks. Nazwa aliasu może być używana zamiast nazwy indeksu dla obsługiwanych operacji.

Nazwa	Typ	Opis
@odata.etag	string	Element ETag aliasu.
indexes	string[]	Nazwa indeksu, na który mapuje ten alias. Można określić tylko jedną nazwę indeksu.
name	string	Nazwa aliasu.