Aliases - Get

Référence

Service:: Search Service

Version d'API:: 2024-09-01-preview

Récupère une définition d’alias.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
aliasName	path	True	string	Nom de l’alias à récupérer.
endpoint	path	True	string	URL du point de terminaison du service de recherche.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string uuid	ID de suivi envoyé avec la demande pour faciliter le débogage.

Réponses

Nom	Type	Description
200 OK	SearchAlias
Other Status Codes	ErrorResponse	Réponse d’erreur.

Exemples

SearchServiceGetAlias

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
SearchAlias	Représente un alias d’index, qui décrit un mappage du nom de l’alias à un index. Le nom d’alias peut être utilisé à la place du nom d’index pour les opérations prises en charge.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

SearchAlias

Représente un alias d’index, qui décrit un mappage du nom de l’alias à un index. Le nom d’alias peut être utilisé à la place du nom d’index pour les opérations prises en charge.

Nom	Type	Description
@odata.etag	string	ETag de l’alias.
indexes	string[]	Nom de l’index auquel cet alias est mappé. Un seul nom d’index peut être spécifié.
name	string	Nom de l’alias.

Partager via