Aliases - Get

Serviço:: Search Service

Versão da API:: 2023-10-01-Preview

Recupera uma definição de alias.

GET {endpoint}/aliases('{aliasName}')?api-version=2023-10-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)	A ID de acompanhamento enviada com a solicitação para ajudar na depuração.

Respostas

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

Exemplos

SearchServiceGetAlias

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
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.
SearchError	Descreve uma condição de erro para a API.

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 este alias é mapeado. Somente um nome de índice pode ser especificado.
name	string	O nome do alias.

SearchError

Objeto

Descreve uma condição de erro para a API.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
message	string	Uma representação legível pelo ser humano do erro.