Indexers - Get Status

Referenz

Service:: Search Service

API Version:: 2023-10-01-Preview

Gibt den aktuellen Status und Ausführungsverlauf eines Indexers zurück.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
indexerName	path	True	string	Der Name des Indexers, für den der Status abgerufen werden soll.
api-version	query	True	string	Client-API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string uuid	Die Tracking-ID, die mit der Anforderung gesendet wurde, beim Debuggen zu helfen.

Antworten

Name	Typ	Beschreibung
200 OK	SearchIndexerStatus
Other Status Codes	SearchError	Fehlerantwort.

Beispiele

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

Definitionen

Name	Beschreibung
IndexerCurrentState	Stellt den gesamten Zustand dar, der die aktuelle Ausführung des Indexers definiert und diktiert.
IndexerExecutionResult	Stellt das Ergebnis einer einzelnen Indexerausführung dar.
IndexerExecutionStatus	Stellt den Status einer einzelnen Indexerausführung dar.
IndexerExecutionStatusDetail	Details zum status einer einzelnen Indexerausführung.
IndexerStatus	Stellt den Gesamtstatus des Indexers dar.
IndexingMode	Stellt den Modus dar, in dem der Indexer ausgeführt wird.
SearchError	Beschreibt eine Fehlerbedingung für die API.
SearchIndexerError	Stellt einen Indizierungsfehler auf Element- oder Dokumentebene dar.
SearchIndexerLimits
SearchIndexerStatus	Stellt den aktuellen Status und Ausführungsverlauf eines Indexers dar.
SearchIndexerWarning	Stellt eine Warnung auf Elementebene dar.

IndexerCurrentState

Stellt den gesamten Zustand dar, der die aktuelle Ausführung des Indexers definiert und diktiert.

Name	Typ	Beschreibung
allDocsFinalChangeTrackingState	string	Ändern Sie den Nachverfolgungsstatuswert, wenn die Indizierung für alle Dokumente in der Datenquelle abgeschlossen ist.
allDocsInitialChangeTrackingState	string	Ändern Sie den Status der Nachverfolgung, der beim Indizieren für alle Dokumente in der Datenquelle verwendet wird.
mode	IndexingMode	Der Modus, in dem der Indexer ausgeführt wird.
resetDatasourceDocumentIds	string[]	Die Liste der zurückgesetzten Datenquellendokument-IDs. Die Datenquellendokument-ID ist der eindeutige Bezeichner für die Daten in der Datenquelle. Der Indexer priorisiert die selektive erneute Erfassung dieser IDs.
resetDocsFinalChangeTrackingState	string	Ändern Sie den Wert des Nachverfolgungsstatus, wenn die Indizierung bei der Auswahl abgeschlossen ist, und setzen Sie Dokumente in der Datenquelle zurück.
resetDocsInitialChangeTrackingState	string	Ändern Sie den Status der Nachverfolgung, der beim Starten der Indizierung bei auswahl verwendet wird, und setzen Sie Dokumente in der Datenquelle zurück.
resetDocumentKeys	string[]	Die Liste der zurückgesetzten Dokumentschlüssel. Der Dokumentschlüssel ist der eindeutige Bezeichner des Dokuments für die Daten im Suchindex. Der Indexer priorisiert die selektive erneute Erfassung dieser Schlüssel.

IndexerExecutionResult

Stellt das Ergebnis einer einzelnen Indexerausführung dar.

Name	Typ	Beschreibung
currentState	IndexerCurrentState	Der gesamte Zustand, der die aktuelle Ausführung des Indexers definiert und diktiert.
endTime	string	Die Endzeit dieser Indexerausführung, wenn die Ausführung bereits abgeschlossen wurde.
errorMessage	string	Die Fehlermeldung, die den Fehler der obersten Ebene angibt, falls vorhanden.
errors	SearchIndexerError[]	Die Indizierungsfehler auf Elementebene.
finalTrackingState	string	Ändern Sie den Nachverfolgungsstatus, mit dem eine Indexerausführung abgeschlossen wurde.
initialTrackingState	string	Ändern Sie den Nachverfolgungsstatus, mit dem eine Indexerausführung gestartet wurde.
itemsFailed	integer	Die Anzahl der Elemente, die während dieser Indexerausführung nicht indiziert werden konnten.
itemsProcessed	integer	Die Anzahl der Elemente, die während dieser Indexerausführung verarbeitet wurden. Dies umfasst sowohl erfolgreich verarbeitete Elemente als auch Elemente, bei denen die Indizierung versucht wurde, aber fehlgeschlagen ist.
startTime	string	Die Startzeit dieser Indexerausführung.
status	IndexerExecutionStatus	Das Ergebnis dieser Indexerausführung.
statusDetail	IndexerExecutionStatusDetail	Das Ergebnis dieser Indexerausführung.
warnings	SearchIndexerWarning[]	Die Indizierungswarnungen auf Elementebene.

IndexerExecutionStatus

Stellt den Status einer einzelnen Indexerausführung dar.

Name	Typ	Beschreibung
inProgress	string	Die Indexerausführung wird ausgeführt.
reset	string	Der Indexer wurde zurückgesetzt.
success	string	Die Indexerausführung wurde erfolgreich abgeschlossen.
transientFailure	string	Bei einem Indexeraufruf ist ein Fehler aufgetreten, aber der Fehler ist möglicherweise vorübergehend. Indexeraufrufe werden gemäß Zeitplan fortgesetzt.

IndexerExecutionStatusDetail

Details zum status einer einzelnen Indexerausführung.

Name	Typ	Beschreibung
resetDocs	string	Gibt an, dass die Zurücksetzung für einen Aufruf von ResetDocs erfolgt ist.

IndexerStatus

Stellt den Gesamtstatus des Indexers dar.

Name	Typ	Beschreibung
error	string	Gibt an, dass beim Indexer ein Fehler aufgetreten ist, der ohne menschliches Eingreifen nicht korrigiert werden kann.
running	string	Gibt an, dass der Indexer normal ausgeführt wird.
unknown	string	Gibt an, dass sich der Indexer in einem unbekannten Zustand befindet.

IndexingMode

Stellt den Modus dar, in dem der Indexer ausgeführt wird.

Name	Typ	Beschreibung
indexingAllDocs	string	Der Indexer indiziert alle Dokumente in der Datenquelle.
indexingResetDocs	string	Der Indexer indiziert selektiv und setzt Dokumente in der Datenquelle zurück. Die dokumente, die indiziert werden, werden auf indexer status definiert.

SearchError

Beschreibt eine Fehlerbedingung für die API.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
details	SearchError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

SearchIndexerError

Stellt einen Indizierungsfehler auf Element- oder Dokumentebene dar.

Name	Typ	Beschreibung
details	string	Weitere ausführliche Details zum Fehler, um beim Debuggen des Indexers zu helfen. Dies ist möglicherweise nicht immer verfügbar.
documentationLink	string	Ein Link zu einem Leitfaden zur Problembehandlung für diese Fehlerklassen. Dies ist möglicherweise nicht immer verfügbar.
errorMessage	string	Die Meldung, die den Fehler beschreibt, der beim Verarbeiten des Elements aufgetreten ist.
key	string	Der Schlüssel des Elements, für das bei der Indizierung ein Fehler aufgetreten ist.
name	string	Der Name der Quelle, in der der Fehler aufgetreten ist. Dies kann sich beispielsweise auf einen bestimmten Skill im angefügten Skillset beziehen. Dies ist möglicherweise nicht immer verfügbar.
statusCode	integer	Der status Code, der angibt, warum der Indizierungsvorgang fehlgeschlagen ist. Mögliche Werte sind: 400 für ein falsch formatiertes Eingabedokument, 404 für nicht gefundenes Dokument, 409 für einen Versionskonflikt, 422, wenn der Index vorübergehend nicht verfügbar ist, oder 503 für, wenn der Dienst zu ausgelastet ist.

SearchIndexerLimits

Name	Typ	Beschreibung
maxDocumentContentCharactersToExtract	number	Die maximale Anzahl von Zeichen, die aus einem Dokument extrahiert werden, das für die Indizierung abgerufen wird.
maxDocumentExtractionSize	number	Die maximale Größe eines Dokuments in Bytes, die für die Indizierung als gültig gilt.
maxRunTime	string	Die maximale Dauer, die der Indexer für eine Ausführung ausführen darf.

SearchIndexerStatus

Stellt den aktuellen Status und Ausführungsverlauf eines Indexers dar.

Name	Typ	Beschreibung
executionHistory	IndexerExecutionResult[]	Verlauf der letzten Indexerausführungen, in umgekehrter chronologischer Reihenfolge sortiert.
lastResult	IndexerExecutionResult	Das Ergebnis der letzten oder noch laufenden Indexerausführung.
limits	SearchIndexerLimits	Die Ausführungsgrenzwerte für den Indexer.
status	IndexerStatus	Gesamtstatus des Indexers.

SearchIndexerWarning

Stellt eine Warnung auf Elementebene dar.

Name	Typ	Beschreibung
details	string	Zusätzliche ausführliche Details zur Warnung, die beim Debuggen des Indexers helfen soll. Dies ist möglicherweise nicht immer verfügbar.
documentationLink	string	Ein Link zu einem Leitfaden zur Problembehandlung für diese Warnungsklassen. Dies ist möglicherweise nicht immer verfügbar.
key	string	Der Schlüssel des Elements, das eine Warnung generiert hat.
message	string	Die Meldung, die die Warnung beschreibt, die während der Verarbeitung des Elements aufgetreten ist.
name	string	Der Name der Quelle, von der die Warnung stammt. Dies kann sich beispielsweise auf einen bestimmten Skill im angefügten Skillset beziehen. Dies ist möglicherweise nicht immer verfügbar.

Share via