Partager via

Get Indexer (API REST Azure AI Search)

  • Article

L’opération Get Indexer obtient la définition de l’indexeur à partir d’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]

Paramètres URI

Paramètre Description
nom du service Obligatoire. Définissez sur le nom unique défini par l’utilisateur de votre service de recherche.
nom de l’indexeur Obligatoire. L’URI de requête spécifie le nom de l’indexeur à retourner.
api-version Pour obtenir la liste des versions prises en charge, consultez Versions d’API .

En-têtes de requête

Le tableau suivant décrit les en-têtes de demande obligatoires et facultatifs.

Champs Description
Content-Type Obligatoire. Paramètre à définir sur application/json
api-key Facultatif si vous utilisez des rôles Azure et qu’un jeton de porteur est fourni sur la demande, sinon une clé est requise. Si vous utilisez des clés API, spécifiez une clé d’administration (par opposition à une clé de requête) pour renvoyer des informations d’objet à partir du service de recherche. Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé .

Corps de la demande

Aucun.

response

Code d'état : 200 OK est retourné pour une réponse correcte. La réponse est similaire aux exemples dans Créer un indexer (API REST Recherche Azure AI) :

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

Notes

Si l’indexeur dispose d’une clé de chiffrement, le service de recherche doit avoir accès à la clé de chiffrement pour récupérer la définition de l’indexeur. Sans accès à la clé de chiffrement, une requête incorrecte 400 est retournée. La restauration de l’accès à la clé permet au service de recherche de récupérer à nouveau la définition de l’indexeur.

Voir aussi