Aliases - List

Referência

Service:: Search Service

API Version:: 2023-10-01-Preview

Listas todos os aliases disponíveis para um serviço de pesquisa.

GET {endpoint}/aliases?api-version=2023-10-01-Preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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 rastreamento enviada com a solicitação para ajudar na depuração.

Respostas

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

Exemplos

SearchServiceListAliases

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "production",
      "indexes": [
        "hotels"
      ]
    },
    {
      "name": "staging",
      "indexes": [
        "testindex"
      ]
    }
  ]
}

Definições

Nome	Description
ListAliasesResult	Resposta de uma solicitação de Aliases de lista. Se tiver êxito, ele incluirá os mapeamentos de índice associados para todos os aliases.
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.

ListAliasesResult

Resposta de uma solicitação de Aliases de lista. Se tiver êxito, ele incluirá os mapeamentos de índice associados para todos os aliases.

Nome	Tipo	Description
value	SearchAlias[]	Os aliases no serviço Pesquisa.

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.

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.

SearchError

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 do erro.

Compartilhar via