Indexers - Get Status

Referenz

Dienst:: Search Service

API-Version:: 2024-11-01-preview

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

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2024-11-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, um beim Debuggen zu helfen.

Antworten

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

Beispiele

SearchServiceGetIndexerStatus

Beispielanforderung

HTTP

GET https://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2024-11-01-preview

Beispiel für eine Antwort

Statuscode:: 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
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
IndexerCurrentState	Stellt den gesamten Zustand dar, der die aktuelle Ausführung des Indexers definiert und bestimmt.
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 Gesamtindexerstatus dar.
IndexingMode	Stellt den Modus dar, in dem der Indexer ausgeführt wird.
SearchIndexerError	Stellt einen Indizierungsfehler auf Element- oder Dokumentebene dar.
SearchIndexerLimits
SearchIndexerStatus	Stellt den aktuellen Status und den Ausführungsverlauf eines Indexers dar.
SearchIndexerWarning	Stellt eine Warnung auf Elementebene dar.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IndexerCurrentState

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

Name	Typ	Beschreibung
allDocsFinalChangeTrackingState	string	Änderungsnachverfolgungsstatuswert, wenn die Indizierung für alle Dokumente in der Datenquelle abgeschlossen ist.
allDocsInitialChangeTrackingState	string	Änderungsnachverfolgungsstatus, der beim Starten der Indizierung 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 Datenquellendokument-IDs, die zurückgesetzt wurden. Die Dokument-ID der Datenquelle ist der eindeutige Bezeichner für die Daten in der Datenquelle. Der Indexer priorisiert selektiv die Aufnahme dieser IDs.
resetDocsFinalChangeTrackingState	string	Ändern sie den Statuswert der Nachverfolgung, wenn die Indizierung bei auswahl abgeschlossen ist, setzen Sie Dokumente in der Datenquelle zurück.
resetDocsInitialChangeTrackingState	string	Änderungsnachverfolgungsstatus, der beim Starten der Indizierung beim Auswählen verwendet wird, 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 selektiv die Neuaufnahme 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 Indizierungsausführung, wenn die Ausführung bereits abgeschlossen ist.
errorMessage	string	Die Fehlermeldung, die den Fehler auf oberster Ebene angibt, falls vorhanden.
errors	SearchIndexerError[]	Fehler bei der Indizierung auf Elementebene.
finalTrackingState	string	Änderungsnachverfolgungsstatus, mit dem die Indizierungsausführung abgeschlossen wurde.
initialTrackingState	string	Änderungsnachverfolgungsstatus, mit dem eine Indizierungsausfü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 Indizierungsausführung.
status	IndexerExecutionStatus	Das Ergebnis dieser Indizierungsausführung.
statusDetail	IndexerExecutionStatusDetail	Das Ergebnis dieser Indizierungsausführung.
warnings	SearchIndexerWarning[]	Die Indizierungswarnungen auf Elementebene.

IndexerExecutionStatus

Stellt den Status einer einzelnen Indexerausführung dar.

Name	Typ	Beschreibung
inProgress	string	Die Indizierungsausführung wird ausgeführt.
reset	string	Indexer wurde zurückgesetzt.
success	string	Die Indexerausführung wurde erfolgreich abgeschlossen.
transientFailure	string	Ein Indizierungsaufruf ist fehlgeschlagen, der Fehler kann jedoch vorübergehend sein. Indizierungsaufrufe werden pro Zeitplan fortgesetzt.

IndexerExecutionStatusDetail

Details zum Status einer einzelnen Indexerausführung.

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

IndexerStatus

Stellt den Gesamtindexerstatus dar.

Name	Typ	Beschreibung
error	string	Gibt an, dass der Indexer einen Fehler erlebt hat, der ohne menschliche Eingriffe 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 selektive Dokumente in der Datenquelle zurück. Die indizierten Dokumente werden für den Indexerstatus definiert.

SearchIndexerError

Stellt einen Indizierungsfehler auf Element- oder Dokumentebene dar.

Name	Typ	Beschreibung
details	string	Weitere ausführliche Details zum Fehler zur Unterstützung beim Debuggen des Indexers. Dies ist möglicherweise nicht immer verfügbar.
documentationLink	string	Ein Link zu einer Anleitung 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 die Indizierung fehlgeschlagen ist.
name	string	Der Name der Quelle, an der der Fehler stammt. Dies kann sich beispielsweise auf eine bestimmte Fähigkeit im angefügten Skillset beziehen. Dies ist möglicherweise nicht immer verfügbar.
statusCode	integer	Der Statuscode, der angibt, warum der Indizierungsvorgang fehlgeschlagen ist. Mögliche Werte sind: 400 für ein falsch formatiertes Eingabedokument, 404 für das Dokument nicht gefunden, 409 für einen Versionskonflikt, 422, wenn der Index vorübergehend nicht verfügbar ist, oder 503, 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 aufgenommen wird.
maxDocumentExtractionSize	number	Die maximale Größe eines Dokuments in Byte, die für die Indizierung als gültig angesehen wird.
maxRunTime	string	Die maximale Dauer, die der Indexer für eine Ausführung ausführen darf.

SearchIndexerStatus

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

Name	Typ	Beschreibung
executionHistory	IndexerExecutionResult[]	Verlauf der letzten Indizierungsausführungen, sortiert in umgekehrter chronologischer Reihenfolge.
lastResult	IndexerExecutionResult	Das Ergebnis der letzten oder einer in Bearbeitung ausgeführten Indizierungsausführung.
limits	SearchIndexerLimits	Die Ausführungsgrenzwerte für den Indexer.
status	IndexerStatus	Gesamtindexerstatus.

SearchIndexerWarning

Stellt eine Warnung auf Elementebene dar.

Name	Typ	Beschreibung
details	string	Weitere ausführliche Details zur Warnung zur Unterstützung beim Debuggen des Indexers. Dies ist möglicherweise nicht immer verfügbar.
documentationLink	string	Ein Link zu einem Handbuch 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 beim Verarbeiten des Elements aufgetreten ist.
name	string	Der Name der Quelle, an der die Warnung stammt. Dies kann sich beispielsweise auf eine bestimmte Fähigkeit im angefügten Skillset beziehen. Dies ist möglicherweise nicht immer verfügbar.

Freigeben über