Aliases - Get

Service:
Search Service
Version d'API:
2025-11-01-preview

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

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

Paramètres URI

Nom Dans Obligatoire Type Description
aliasName
 path True

string

Nom de l’alias.
endpoint
 path True

string (uri)

URL du point de terminaison du service de recherche.
api-version
 query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom Obligatoire Type Description
Accept

Accept

L’en-tête Accept.
x-ms-client-request-id

string (uuid)

Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Réponses

Nom Type Description
200 OK

SearchAlias

La demande a réussi.
Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

api-key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

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

Exemples

SearchServiceGetAlias

Exemple de requête

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

Exemple de réponse

Code d’état:
200 
{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

Définitions

Nom Description
Accept

L’en-tête Accept.
ErrorAdditionalInfo

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

Détail de l’erreur.
ErrorResponse

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
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.

Accept

Énumération

L’en-tête Accept.

Valeur Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objet

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

Nom Type Description
info

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Objet

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

Objet

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom Type Description
error

ErrorDetail

Objet d’erreur.

SearchAlias

Objet

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

L’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.