Status van indexeerfunctie ophalen (Azure AI Search REST API)

De bewerking Status van indexeerfunctie ophalen haalt de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie op:

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

URI-parameters

Parameter	Beschrijving
servicenaam	Vereist. Stel deze 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 waarvoor de status moet worden geretourneerd.
api-versie	Vereist. De huidige stabiele versie is api-version=2020-06-30. Zie API-versies voor meer versies.
failIfCannotDecrypt	Optioneel, wordt standaard ingesteld op true als dit niet is opgegeven. Als de indexeerfunctie is gemaakt met behulp van een versleutelingssleutel en de zoekservice geen toegang heeft tot de versleutelingssleutel, mislukt het ophalen van de indexeerfunctiestatus. Indien onwaar, heeft de geretourneerde indexeerfunctiestatus versleutelde eigenschappen vervangen "<encrypted>" door tijdelijke aanduidingen.

Aanvraagheaders

In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.

Velden	Description
Content-Type	Vereist. Stel dit in 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. Een API-sleutel is een unieke, door het systeem gegenereerde tekenreeks die de aanvraag verifieert bij uw zoekservice. Aanvragen voor een objectdefinitie moeten een api-sleutelveld bevatten dat is ingesteld op uw beheerderssleutel (in plaats van een querysleutel). Zie Verbinding maken met Azure AI Search met behulp van sleutelverificatie voor meer informatie.

Aanvraagbody

Geen.

Antwoord

Statuscode: 200 OK voor een geslaagd antwoord. De hoofdtekst van het antwoord bevat informatie over de algehele status van de indexeerfunctie, de laatste aanroep van de indexeerfunctie en de geschiedenis van recente aanroepen van de indexeerfunctie (indien aanwezig).

Een voorbeeld van de antwoordtekst ziet er als volgt uit:

{
    "status" : "running",
    "lastResult" : {
        "status" : "success",
        "errorMessage" : null,
        "startTime" : "2014-11-26T03:37:18.853Z",
        "endTime" : "2014-11-26T03:37:19.012Z",
        "errors" : [],
        "warnings" : [],
        "itemsProcessed" : 11,
        "itemsFailed" : 0,
        "initialTrackingState" : null,
        "finalTrackingState" : null
    },
    "executionHistory" : [
        {
            "status" : "success",
            "errorMessage" : null,
            "startTime" : "2014-11-26T03:37:18.853Z",
            "endTime" : "2014-11-26T03:37:19.012Z",
            "errors" : [],
            "warnings" : [],
            "itemsProcessed" : 11,
            "itemsFailed" : 0,
            "initialTrackingState" : null,
            "finalTrackingState" : null
        },
        {
            "status" : "transientFailure",
            "errorMessage" : null,
            "startTime" : "2014-11-26T03:28:10.125Z",
            "endTime" : "2014-11-26T03:28:12.007Z",
            "errors" : [
                {
                    "key" : "",
                    "name" : "The operation name describing where the error occurred. For example, 'Enrichment.LanguageDetectionSkill.SkillName'",
                    "errorMessage" : "Document key cannot be missing or empty.",
                    "statusCode" : 400,
                    "details" : "Any additional details, such as the WebApi response if executing a custom skill failed.",
                    "documentationLink" : "A link to relevant documentation. For example, 'https://go.microsoft.com/fwlink/?linkid=2099692'""
                }
            ],
            "warnings" : [
                {
                    "key" : "document id",
                    "name" : "The operation name describing where the warning occurred. For example, 'Enrichment.LanguageDetectionSkill.SkillName'",
                    "message" : "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob."
                    "details" : "Any additional details, such as the WebApi response if executing a custom skill failed.",
                    "documentationLink" : "A link to relevant documentation. For example, 'https://go.microsoft.com/fwlink/?linkid=2099692'"
                }
            ],
            "itemsProcessed" : 1,
            "itemsFailed" : 1,
            "initialTrackingState" : null,
            "finalTrackingState" : null
        }
    ]
}

Notitie

Als de indexeerfunctie is gemaakt met behulp van een versleutelingssleutel, kunnen versleutelde eigenschappen van de status alleen worden opgehaald als de zoekservice toegang heeft tot de versleutelingssleutel. Als de zoekservice geen toegang heeft tot de versleutelingssleutel, wordt standaard een 400 Ongeldige aanvraag geretourneerd. Geef failIfCannotDecrypt=false op om de status op te halen met "<encrypted>" tijdelijke aanduidingen die versleutelde eigenschappen vervangen.

Status van indexeerfunctie

De status van de indexeerfunctie kan een van de volgende waarden zijn:

• uitvoeren geeft aan dat de indexeerfunctie normaal wordt uitgevoerd. Sommige uitvoeringen van de indexeerfunctie mislukken mogelijk nog steeds, dus het is een goed idee om ook de eigenschap lastResult te controleren.

• geeft aan dat de indexeerfunctie een fout heeft ondervonden die niet kan worden gecorrigeerd zonder menselijke tussenkomst. De referenties van de gegevensbron zijn bijvoorbeeld verlopen of het schema van de gegevensbron of van de doelindex is op een belangrijke manier gewijzigd.

Resultaat van de uitvoering van de indexeerfunctie

Een uitvoeringsresultaat van een indexeerfunctie bevat informatie over de uitvoering van één indexeerfunctie. Het meest recente resultaat wordt weergegeven als de eigenschap lastResult van de status van de indexeerfunctie. Andere recente resultaten, indien aanwezig, worden geretourneerd als de eigenschap executionHistory van de indexeerfunctiestatus.

Het uitvoeringsresultaat van de indexeerfunctie bevat de volgende eigenschappen:

• status: de status van een uitvoering. Zie Uitvoeringsstatus van indexeerfunctie hieronder voor meer informatie.

• errorMessage: foutbericht voor een mislukte uitvoering.

• startTime: de tijd in UTC waarop deze uitvoering is gestart.

• endTime: de tijd in UTC waarop deze uitvoering is beëindigd. Deze waarde wordt niet ingesteld als de uitvoering nog steeds wordt uitgevoerd.

• errors: een lijst met fouten op itemniveau, indien van toepassing. Zie het voorbeeldantwoord hierboven voor een voorbeeld. Vanaf de API-versie 2020-06-30 bevat elke fout in de lijst niet langer een "status" omdat dit voor fouten op itemniveau altijd onwaar was. Vanaf de API-versie 2020-06-30bevat elke fout in de lijst de nieuwe eigenschappen "name", "details"en "documentationLink".

• waarschuwingen: een lijst met waarschuwingen op itemniveau, indien van toepassing. Zie het voorbeeldantwoord hierboven voor een voorbeeld. Vanaf DE API-versie 2020-06-30bevat elke waarschuwing in de lijst de nieuwe eigenschappen "name", "details"en "documentationLink".

• itemsProcessed: het aantal gegevensbronitems (bijvoorbeeld tabelrijen) dat de indexeerfunctie tijdens deze uitvoering heeft geprobeerd te indexeren.

• itemsFailed: het aantal items dat is mislukt tijdens deze uitvoering. De fout geeft de id op van het item dat is mislukt.

• initialTrackingState: altijd null voor de eerste uitvoering van de indexeerfunctie of als het beleid voor het bijhouden van gegevenswijziging niet is ingeschakeld voor de gegevensbron die wordt gebruikt. Als een dergelijk beleid is ingeschakeld, geeft deze waarde in volgende uitvoeringen de eerste (laagste) waarde voor het bijhouden van wijzigingen aan die door deze uitvoering wordt verwerkt.

• finalTrackingState: altijd null als het beleid voor het bijhouden van gegevenswijziging niet is ingeschakeld voor de gebruikte gegevensbron. Anders geeft de meest recente (hoogste) waarde voor het bijhouden van wijzigingen aan die door deze uitvoering is verwerkt.

Uitvoeringsstatus van indexeerfunctie

De uitvoeringsstatus van de indexeerfunctie legt de status van de uitvoering van één indexeerfunctie vast. Het kan de volgende waarden hebben:

• geslaagd geeft aan dat de uitvoering van de indexeerfunctie is voltooid.

• inProgress geeft aan dat de uitvoering van de indexeerfunctie wordt uitgevoerd.

• transientFailure geeft aan dat de uitvoering van een indexeerfunctie is mislukt. Zie de eigenschap errorMessage voor meer informatie. Voor de fout is mogelijk al dan niet menselijke tussenkomst vereist om het probleem op te lossen. Als u bijvoorbeeld een incompatibiliteit van een schema tussen de gegevensbron en de doelindex wilt herstellen, is gebruikersactie vereist, terwijl een tijdelijke downtime van de gegevensbron dat niet doet. Aanroepen van indexeerfuncties worden per schema voortgezet, als er een is gedefinieerd. Als een indexeerfunctie in een schema herhaaldelijk een tijdelijkefailure-status bereikt zonder voortgang te maken, wordt de indexeerfunctie uitgevoerd met een minder frequent interval (tot het maximum van ten minste eenmaal per 24 uur) totdat de voortgang opnieuw wordt uitgevoerd.

• persistentFailure geeft aan dat de indexeerfunctie is mislukt op een manier die menselijke tussenkomst vereist. Geplande uitvoeringen van de indexeerfunctie stoppen. Nadat het probleem is opgelost, gebruikt u Reset Indexer (Azure AI Search REST API) om de geplande uitvoeringen opnieuw te starten.

• reset geeft aan dat de indexeerfunctie opnieuw is ingesteld door een aanroep van Reset Indexer (Azure AI Search REST API).

Zie ook

• Overzicht van de indexeerfunctie
• Indexeerfuncties maken