Aliases - Get

Servicio:

Search Service

Versión de la API:

2023-10-01-Preview

Recupera una definición de alias.

GET {endpoint}/aliases('{aliasName}')?api-version=2023-10-01-Preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
aliasName	path	True	string	Nombre del alias que se va a recuperar.
endpoint	path	True	string	Dirección URL del punto de conexión del servicio de búsqueda.
api-version	query	True	string	Versión de api de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string uuid	Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Respuestas

Nombre	Tipo	Description
200 OK	SearchAlias
Other Status Codes	SearchError	Respuesta de error.

Ejemplos

SearchServiceGetAlias

Solicitud de ejemplo

HTTP

GET https://myservice.search.windows.net/aliases('production')?api-version=2023-10-01-Preview

Respuesta de muestra

status code:

200

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

Definiciones

Nombre	Description
SearchAlias	Representa un alias de índice, que describe una asignación del nombre del alias a un índice. El nombre del alias se puede usar en lugar del nombre del índice para las operaciones admitidas.
SearchError	Describe una condición de error para la API.

SearchAlias

Representa un alias de índice, que describe una asignación del nombre del alias a un índice. El nombre del alias se puede usar en lugar del nombre del índice para las operaciones admitidas.

Nombre	Tipo	Description
@odata.etag	string	ETag del alias.
indexes	string[]	Nombre del índice al que se asigna este alias. Solo se puede especificar un nombre de índice.
name	string	Nombre del alias.

SearchError

Describe una condición de error para la API.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
details	SearchError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
message	string	Representación legible del error.