Obtención de indexador (API REST de Azure AI Search)

  • Artículo

La operación Obtener indexador obtiene la definición del indexador de 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 identificador URI

Parámetro Descripción
nombre del servicio Necesario. Establezca en el nombre único definido por el usuario del servicio de búsqueda.
nombre del indexador Necesario. El URI de solicitud especifica el nombre del indexador que se va a devolver.
api-version Consulte Versiones de API para obtener una lista de las versiones admitidas.

Encabezados de solicitud

En la siguiente tabla se describen los encabezados de solicitud obligatorios y opcionales.

Campos Descripción
Content-Type Necesario. Establézcala en application/json
api-key Opcional si usa roles de Azure y se proporciona un token de portador en la solicitud; de lo contrario, se requiere una clave. Si usa claves de API, especifique una clave de administrador (en lugar de una clave de consulta) para devolver información de objeto desde el servicio de búsqueda. Consulte Conexión a Azure AI Search mediante la autenticación de claves para más información.

Cuerpo de la solicitud

Ninguno.

Response

Código de estado: al obtener una respuesta correcta, se visualiza 200 Correcto. La respuesta es similar a los ejemplos de Creación de indexador (API REST de 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
}

Nota

Si el indexador tiene una clave de cifrado, el servicio de búsqueda debe tener acceso a la clave de cifrado para recuperar la definición del indexador. Sin acceso a la clave de cifrado, se devuelve una solicitud incorrecta 400. Restaurar el acceso a la clave permite al servicio de búsqueda recuperar de nuevo la definición del indexador.

Consulte también