Obter Indexador (API REST do Azure AI Search)

  • Artigo

A operação Obter Indexador obtém a definição do indexador 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 de URI

Parâmetro Descrição
nome do serviço Obrigatórios. Defina como o nome exclusivo definido pelo usuário do serviço de pesquisa.
nome do indexador Obrigatórios. O URI de solicitação especifica o nome do indexador a ser retornado.
api-version Consulte versões de API para obter uma lista de versões com suporte.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos de solicitação necessários e opcionais

Campos Descrição
Tipo de conteúdo Obrigatórios. Definida como application/json
chave de API Opcional se você estiver usando funções do Azure e um token de portador for fornecido na solicitação, caso contrário, uma chave será necessária. Se você estiver usando chaves de API, especifique uma chave de administrador (em vez de uma chave de consulta) para retornar informações de objeto do serviço de pesquisa. Confira Conectar-se ao Azure AI Search usando a autenticação de chave para obter detalhes.

Corpo da solicitação

Nenhum.

Resposta

Código de status: 200 OK é retornado para uma resposta bem-sucedida. A resposta é semelhante a exemplos em Criar Indexador (API REST do Azure AI Search):

{  
    "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
}

Observação

Se o indexador tiver uma chave de criptografia, o serviço de pesquisa deverá ter acesso à chave de criptografia para recuperar a definição do indexador. Sem acesso à chave de criptografia, uma Solicitação 400 Inválida é retornada. Restaurar o acesso à chave permite que o serviço de pesquisa recupere a definição do indexador novamente.

Confira também