Aliases - Get

Referência

Serviço:: Search Service

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

Obtém uma definição de alias.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
aliasName	path	True	string	O nome do alias a obter.
endpoint	path	True	string	O URL do ponto final do serviço de pesquisa.
api-version	query	True	string	Versão da API de Cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	O ID de controlo enviado com o pedido para ajudar na depuração.

Respostas

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

Exemplos

SearchServiceGetAlias

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
SearchAlias	Representa um alias de índice, que descreve um mapeamento do nome do alias para um índice. O nome do alias pode ser utilizado em vez do nome do índice para operações suportadas.
SearchError	Descreve uma condição de erro para a API.

SearchAlias

Representa um alias de índice, que descreve um mapeamento do nome do alias para um índice. O nome do alias pode ser utilizado em vez do nome do índice para operações suportadas.

Name	Tipo	Description
@odata.etag	string	O ETag do alias.
indexes	string[]	O nome do índice a que este alias se mapeia. Só pode ser especificado um nome de índice.
name	string	O nome do alias.

SearchError

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

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
message	string	Uma representação legível por humanos do erro.

Partilhar via