Aliases - Get

Serviço:: Search Service

Versão da API:: 2025-08-01-preview

Recupera uma definição de alias.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
aliasName	path	True	string	O nome do alias a ser recuperado.
endpoint	path	True	string	A URL do ponto de extremidade do serviço de pesquisa.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string (uuid)	O ID de rastreamento enviado com a solicitação para ajudar na depuração.

Respostas

Nome	Tipo	Description
200 OK	SearchAlias
Other Status Codes	ErrorResponse	Resposta de erro.

Exemplos

SearchServiceGetAlias

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
SearchAlias	Representa um alias de índice, que descreve um mapeamento do nome do alias para um índice. O nome do alias pode ser usado no lugar do nome do índice para operações com suporte.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código do erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

SearchAlias

Objeto

Representa um alias de índice, que descreve um mapeamento do nome do alias para um índice. O nome do alias pode ser usado no lugar do nome do índice para operações com suporte.

Nome	Tipo	Description
@odata.etag	string	A ETag do alias.
indexes	string[]	O nome do índice para o qual esse alias é mapeado. Somente um nome de índice pode ser especificado.
name	string	O nome do alias.