Aliases - Get

Servizio:: Search Service

Versione API:: 2024-09-01-preview

Recupera una definizione di alias.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
aliasName	path	True	string	Nome dell'alias da recuperare.
endpoint	path	True	string	URL dell'endpoint del servizio di ricerca.
api-version	query	True	string	Versione dell'API client.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string (uuid)	ID di rilevamento inviato con la richiesta per facilitare il debug.

Risposte

Nome	Tipo	Descrizione
200 OK	SearchAlias
Other Status Codes	ErrorResponse	Risposta di errore.

Esempio

SearchServiceGetAlias

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

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

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
SearchAlias	Rappresenta un alias di indice, che descrive un mapping dal nome alias a un indice. Il nome alias può essere usato al posto del nome dell'indice per le operazioni supportate.

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

SearchAlias

Oggetto

Rappresenta un alias di indice, che descrive un mapping dal nome alias a un indice. Il nome alias può essere usato al posto del nome dell'indice per le operazioni supportate.

Nome	Tipo	Descrizione
@odata.etag	string	ETag dell'alias.
indexes	string[]	Nome dell'indice a cui viene mappato questo alias. È possibile specificare un solo nome di indice.
name	string	Nome dell'alias.