Indexer ophalen (Azure AI Search REST API)
Met de bewerking Indexeerfunctie ophalen wordt de definitie van de indexeerfunctie opgehaald uit 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]
URI-parameters
Parameter | Beschrijving |
---|---|
servicenaam | Vereist. Stel in op de unieke, door de gebruiker gedefinieerde naam van uw zoekservice. |
naam van indexeerfunctie | Vereist. De aanvraag-URI geeft de naam op van de indexeerfunctie die moet worden geretourneerd. |
api-versie | Zie API-versies voor een lijst met ondersteunde versies. |
Aanvraagheaders
In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.
Velden | Description |
---|---|
Content-Type | Vereist. Ingesteld op application/json |
api-sleutel | Optioneel als u Azure-rollen gebruikt en er een bearer-token wordt opgegeven voor de aanvraag, anders is een sleutel vereist. Als u API-sleutels gebruikt, geeft u een beheersleutel op (in plaats van een querysleutel) om objectgegevens van de zoekservice te retourneren. Zie Verbinding maken met Azure AI Search met behulp van sleutelverificatie voor meer informatie. |
Aanvraagbody
Geen.
Antwoord
Statuscode: 200 OK wordt geretourneerd voor een geslaagd antwoord. Het antwoord is vergelijkbaar met voorbeelden in Create Indexer (Azure AI Search REST API):
{
"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
}
Notitie
Als de indexeerfunctie een versleutelingssleutel heeft, moet de zoekservice toegang hebben tot de versleutelingssleutel om de definitie van de indexeerfunctie op te halen. Zonder toegang tot de versleutelingssleutel wordt een 400 Ongeldige aanvraag geretourneerd. Door de toegang tot de sleutel te herstellen, kan de zoekservice de definitie van de indexeerfunctie opnieuw ophalen.