Share via

Obter Indexador (API REST da Pesquisa de IA do Azure)

  • Artigo

A operação Obter Indexador obtém a definição do indexador a partir do Azure AI Search.

GET https://[service name].search.windows.net/indexers/[indexer name]?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

Parâmetros do URI

Parâmetro Description
nome do serviço Obrigatório. Defina como o nome exclusivo definido pelo utilizador do seu serviço de pesquisa.
nome do indexador Obrigatório. O URI do pedido especifica o nome do indexador a devolver.
api-version Veja Versões da API para obter uma lista de versões suportadas.

Cabeçalhos de Pedido

A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.

Campos Description
Content-Type Obrigatório. Definir como application/json
api-key Opcional se estiver a utilizar funções do Azure e for fornecido um token de portador no pedido, caso contrário, é necessária uma chave. Se estiver a utilizar chaves de API, especifique uma chave de administrador (em oposição a uma chave de consulta) para devolver informações do objeto do serviço de pesquisa. Veja Connect to Azure AI Search using key authentication (Ligar à Pesquisa de IA do Azure com a autenticação de chaves ) para obter detalhes.

Corpo do Pedido

Nenhum.

Resposta

Código de Estado: 200 OK é devolvido para uma resposta com êxito. A resposta é semelhante a exemplos em Criar Indexador (API REST da Pesquisa de IA do Azure):

{  
    "name" : "myindexer",  
    "description" : "a cool indexer",  
    "dataSourceName" : "ordersds",  
    "targetIndexName" : "orders",  
    "schedule" : { "interval" : "PT1H", "startTime" : "2015-01-01T00:00:00Z" },  
    "parameters" : { "maxFailedItems" : 10, "maxFailedItemsPerBatch" : 5, "base64EncodeKeys": false },
    "encryptionKey": null
}

Nota

Se o indexador tiver uma chave de encriptação, o serviço de pesquisa tem de ter acesso à chave de encriptação para obter a definição do indexador. Sem acesso à chave de encriptação, é devolvido um Pedido Incorreto 400. Restaurar o acesso à chave permite que o serviço de pesquisa obtenha novamente a definição do indexador.

Ver também