Aliases - Get

Referência

Serviço:: Search Service

Versão da API:: 2024-09-01-preview

Recupera uma definição de alias.

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

Parâmetros do URI

Name	Em	Necessá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 do Pedido

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

Respostas

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

Exemplos

SearchServiceGetAlias

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
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 suportadas.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

O detalhe do erro.

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

ErrorResponse

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto 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 suportadas.

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

Partilhar via