Indexers - Get Status

Referentie

Service:: Search Service

API Version:: 2023-10-01-Preview

Retourneert de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2023-10-01-Preview

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
indexerName	path	True	string	De naam van de indexeerfunctie waarvoor de status moet worden opgehaald.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	De tracerings-id die met de aanvraag wordt verzonden om te helpen bij foutopsporing.

Antwoorden

Name	Type	Description
200 OK	SearchIndexerStatus
Other Status Codes	SearchError	Foutreactie.

Voorbeelden

SearchServiceGetIndexerStatus

Sample Request

HTTP

GET https://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2023-10-01-Preview

Sample Response

Status code:: 200

{
  "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": "",
          "errorMessage": "Document key cannot be missing or empty.",
          "statusCode": 400,
          "name": null,
          "details": null,
          "documentationLink": null
        },
        {
          "key": "document id 1",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "details": "The file could not be parsed.",
          "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388"
        }
      ],
      "warnings": [
        {
          "key": "document id",
          "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.",
          "name": null,
          "details": null,
          "documentationLink": null
        },
        {
          "key": "document id 2",
          "message": "Document was truncated to 50000 characters.",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.",
          "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692"
        }
      ],
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "initialTrackingState": null,
      "finalTrackingState": null
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  }
}

Definities

Name	Description
IndexerCurrentState	Vertegenwoordigt alle statussen die de huidige uitvoering van de indexeerfunctie definiëren en dicteren.
IndexerExecutionResult	Vertegenwoordigt het resultaat van de uitvoering van een afzonderlijke indexeerfunctie.
IndexerExecutionStatus	Vertegenwoordigt de status van de uitvoering van een afzonderlijke indexeerfunctie.
IndexerExecutionStatusDetail	Details van de status van de uitvoering van een afzonderlijke indexeerfunctie.
IndexerStatus	Geeft de algemene status van de indexeerfunctie aan.
IndexingMode	Geeft de modus aan waarin de indexeerfunctie wordt uitgevoerd.
SearchError	Beschrijft een foutvoorwaarde voor de API.
SearchIndexerError	Vertegenwoordigt een indexeringsfout op item- of documentniveau.
SearchIndexerLimits
SearchIndexerStatus	Vertegenwoordigt de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.
SearchIndexerWarning	Vertegenwoordigt een waarschuwing op itemniveau.

IndexerCurrentState

Vertegenwoordigt alle statussen die de huidige uitvoering van de indexeerfunctie definiëren en dicteren.

Name	Type	Description
allDocsFinalChangeTrackingState	string	De waarde van de bijgehouden status wijzigen wanneer het indexeren is voltooid voor alle documenten in de gegevensbron.
allDocsInitialChangeTrackingState	string	De status voor het bijhouden van wijzigingen die wordt gebruikt bij het indexeren van alle documenten in de gegevensbron.
mode	IndexingMode	De modus waarin de indexeerfunctie wordt uitgevoerd.
resetDatasourceDocumentIds	string[]	De lijst met document-id's van gegevensbronnen die opnieuw zijn ingesteld. De document-id van de gegevensbron is de unieke id voor de gegevens in de gegevensbron. De indexeerfunctie geeft prioriteit aan het selectief opnieuw opnemen van deze id's.
resetDocsFinalChangeTrackingState	string	Wijzig de waarde van de traceringsstatus wanneer het indexeren is voltooid bij selectie, stel documenten opnieuw in de gegevensbron in.
resetDocsInitialChangeTrackingState	string	Status van wijzigingen bijhouden die wordt gebruikt wanneer indexeren wordt gestart bij selectie, documenten opnieuw instellen in de gegevensbron.
resetDocumentKeys	string[]	De lijst met documentsleutels die opnieuw zijn ingesteld. De documentsleutel is de unieke id van het document voor de gegevens in de zoekindex. De indexeerfunctie geeft prioriteit aan het selectief opnieuw opnemen van deze sleutels.

IndexerExecutionResult

Vertegenwoordigt het resultaat van de uitvoering van een afzonderlijke indexeerfunctie.

Name	Type	Description
currentState	IndexerCurrentState	Alle statussen die de huidige uitvoering van de indexeerfunctie definiëren en dicteren.
endTime	string	De eindtijd van de uitvoering van deze indexeerfunctie, als de uitvoering al is voltooid.
errorMessage	string	Het foutbericht dat de fout op het hoogste niveau aangeeft, indien van toepassing.
errors	SearchIndexerError[]	De indexeringsfouten op itemniveau.
finalTrackingState	string	De status van het bijhouden van wijzigingen waarmee de uitvoering van een indexeerfunctie is voltooid.
initialTrackingState	string	De status van het bijhouden van wijzigingen waarmee de uitvoering van een indexeerfunctie is gestart.
itemsFailed	integer	Het aantal items dat niet kan worden geïndexeerd tijdens het uitvoeren van deze indexeerfunctie.
itemsProcessed	integer	Het aantal items dat is verwerkt tijdens het uitvoeren van deze indexeerfunctie. Dit omvat zowel verwerkte items als items waarvoor de indexering is geprobeerd, maar is mislukt.
startTime	string	De begintijd van de uitvoering van deze indexeerfunctie.
status	IndexerExecutionStatus	Het resultaat van deze uitvoering van de indexeerfunctie.
statusDetail	IndexerExecutionStatusDetail	Het resultaat van deze uitvoering van de indexeerfunctie.
warnings	SearchIndexerWarning[]	De waarschuwingen voor indexering op itemniveau.

IndexerExecutionStatus

Vertegenwoordigt de status van de uitvoering van een afzonderlijke indexeerfunctie.

Name	Type	Description
inProgress	string	De uitvoering van de indexeerfunctie wordt uitgevoerd.
reset	string	De indexeerfunctie is opnieuw ingesteld.
success	string	De uitvoering van de indexeerfunctie is voltooid.
transientFailure	string	Een aanroep van de indexeerfunctie is mislukt, maar de fout kan tijdelijk zijn. De aanroepen van de indexeerfunctie worden volgens schema voortgezet.

IndexerExecutionStatusDetail

Details van de status van de uitvoering van een afzonderlijke indexeerfunctie.

Name	Type	Description
resetDocs	string	Geeft aan dat de reset die is opgetreden, was voor een aanroep naar ResetDocs.

IndexerStatus

Geeft de algemene status van de indexeerfunctie aan.

Name	Type	Description
error	string	Geeft aan dat de indexeerfunctie een fout heeft ondervonden die niet kan worden gecorrigeerd zonder menselijke tussenkomst.
running	string	Geeft aan dat de indexeerfunctie normaal wordt uitgevoerd.
unknown	string	Geeft aan dat de indexeerfunctie een onbekende status heeft.

IndexingMode

Geeft de modus aan waarin de indexeerfunctie wordt uitgevoerd.

Name	Type	Description
indexingAllDocs	string	De indexeerfunctie indexeert alle documenten in de gegevensbron.
indexingResetDocs	string	De indexeerfunctie indexeert selectief en stelt documenten in de gegevensbron opnieuw in. De documenten die worden geïndexeerd, worden gedefinieerd op basis van de status van de indexeerfunctie.

SearchError

Beschrijft een foutvoorwaarde voor de API.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	SearchError[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
message	string	Een door mensen leesbare weergave van de fout.

SearchIndexerError

Vertegenwoordigt een indexeringsfout op item- of documentniveau.

Name	Type	Description
details	string	Aanvullende, uitgebreide informatie over de fout om te helpen bij het opsporen van fouten in de indexeerfunctie. Dit is mogelijk niet altijd beschikbaar.
documentationLink	string	Een koppeling naar een gids voor probleemoplossing voor deze foutenklassen. Dit is mogelijk niet altijd beschikbaar.
errorMessage	string	Het bericht waarin de fout wordt beschreven die is opgetreden tijdens het verwerken van het item.
key	string	De sleutel van het item waarvoor het indexeren is mislukt.
name	string	De naam van de bron waaruit de fout afkomstig is. Dit kan bijvoorbeeld verwijzen naar een bepaalde vaardigheid in de gekoppelde vaardighedenset. Dit is mogelijk niet altijd beschikbaar.
statusCode	integer	De statuscode die aangeeft waarom de indexeringsbewerking is mislukt. Mogelijke waarden zijn: 400 voor een onjuist ingedeeld invoerdocument, 404 voor document niet gevonden, 409 voor een versieconflict, 422 wanneer de index tijdelijk niet beschikbaar is of 503 voor wanneer de service te druk is.

SearchIndexerLimits

Name	Type	Description
maxDocumentContentCharactersToExtract	number	Het maximum aantal tekens dat wordt geëxtraheerd uit een document dat wordt opgehaald voor indexering.
maxDocumentExtractionSize	number	De maximale grootte van een document, in bytes, die als geldig wordt beschouwd voor indexering.
maxRunTime	string	De maximale duur die de indexeerfunctie mag uitvoeren voor één uitvoering.

SearchIndexerStatus

Vertegenwoordigt de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.

Name	Type	Description
executionHistory	IndexerExecutionResult[]	Geschiedenis van de recente uitvoeringen van de indexeerfunctie, gesorteerd in omgekeerd chronologische volgorde.
lastResult	IndexerExecutionResult	Het resultaat van de meest recente of een actieve uitvoering van de indexeerfunctie.
limits	SearchIndexerLimits	De uitvoeringslimieten voor de indexeerfunctie.
status	IndexerStatus	Algemene status van de indexeerfunctie.

SearchIndexerWarning

Vertegenwoordigt een waarschuwing op itemniveau.

Name	Type	Description
details	string	Aanvullende, uitgebreide informatie over de waarschuwing om te helpen bij het opsporen van fouten in de indexeerfunctie. Dit is mogelijk niet altijd beschikbaar.
documentationLink	string	Een koppeling naar een gids voor probleemoplossing voor deze waarschuwingsklassen. Dit is mogelijk niet altijd beschikbaar.
key	string	De sleutel van het item dat een waarschuwing heeft gegenereerd.
message	string	Het bericht met een beschrijving van de waarschuwing die is opgetreden tijdens het verwerken van het item.
name	string	De naam van de bron waaruit de waarschuwing afkomstig is. Dit kan bijvoorbeeld verwijzen naar een bepaalde vaardigheid in de gekoppelde vaardighedenset. Dit is mogelijk niet altijd beschikbaar.

Share via