Indexers - Get Status

Dienst:: Search Service

API-Version:: 2025-11-01-preview

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

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2025-11-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
indexerName	path	True	string	Der Name des Indexers.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Accept		Accept	Die Überschrift "Annehmen".
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Antworten

Name	Typ	Beschreibung
200 OK	SearchIndexerStatus	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name	Beschreibung
https://search.azure.com/.default

Beispiele

SearchServiceGetIndexerStatus

SearchServiceGetS3HDUnlimitedIndexerStatus

SearchServiceGetIndexerStatus

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "myindexer",
  "status": "running",
  "runtime": {
    "usedSeconds": 0,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "mode": "indexingAllDocs",
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "mode": "indexingAllDocs",
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "mode": "indexingAllDocs",
      "errors": [
        {
          "key": "",
          "statusCode": 400,
          "errorMessage": "Document key cannot be missing or empty."
        },
        {
          "key": "document id 1",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "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."
        },
        {
          "key": "document id 2",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "message": "Document was truncated to 50000 characters.",
          "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"
        }
      ]
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": []
  }
}

SearchServiceGetS3HDUnlimitedIndexerStatus

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "myindexer",
  "status": "running",
  "runtime": {
    "usedSeconds": 0,
    "remainingSeconds": 39600,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "mode": "indexingAllDocs",
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "mode": "indexingAllDocs",
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "mode": "indexingAllDocs",
      "errors": [
        {
          "key": "",
          "statusCode": 400,
          "errorMessage": "Document key cannot be missing or empty."
        },
        {
          "key": "document id 1",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "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."
        },
        {
          "key": "document id 2",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "message": "Document was truncated to 50000 characters.",
          "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"
        }
      ]
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": []
  }
}

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
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	Gibt den Status einer einzelnen Indexerausführung an.
IndexerRuntime	Stellt den kumulativen Laufzeitverbrauch des Indexers im Dienst dar.
IndexerStatus	Stellt den Gesamtstatus des Indexers dar.
IndexingMode	Stellt den Modus dar, in dem der Indexer ausgeführt wird.
SearchIndexerError	Stellt einen Indizierungsfehler auf Element- oder Dokumentebene dar.
SearchIndexerLimits	Repräsentiert die Grenzwerte, die auf einen Indexer angewendet werden können.
SearchIndexerStatus	Stellt den aktuellen Status und den Ausführungsverlauf eines Indexers dar.
SearchIndexerWarning	Stellt eine Warnung auf Elementebene dar.

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

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

ErrorDetail

Objekt

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

Objekt

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IndexerCurrentState

Objekt

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

Name	Typ	Beschreibung
allDocsFinalTrackingState	string	Änderungsnachverfolgungsstatuswert, wenn die Indizierung für alle Dokumente in der Datenquelle abgeschlossen ist.
allDocsInitialTrackingState	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.
resetDocsFinalTrackingState	string	Ändern sie den Statuswert der Nachverfolgung, wenn die Indizierung bei auswahl abgeschlossen ist, setzen Sie Dokumente in der Datenquelle zurück.
resetDocsInitialTrackingState	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.
resyncFinalTrackingState	string	Ändern Sie den Wert des Nachverfolgungsstatus, wenn die Indizierung für ausgewählte Optionen aus der Datenquelle abgeschlossen ist.
resyncInitialTrackingState	string	Ändern Sie den Nachverfolgungsstatus, der beim Starten der Indizierung für ausgewählte Optionen aus der Datenquelle verwendet wird.

IndexerExecutionResult

Objekt

Stellt das Ergebnis einer einzelnen Indexerausführung dar.

Name	Typ	Beschreibung
endTime	string (date-time)	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 (int32)	Die Anzahl der Elemente, die während dieser Indexerausführung nicht indiziert werden konnten.
itemsProcessed	integer (int32)	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.
mode	IndexingMode	Der Modus, in dem der Indexer ausgeführt wird.
startTime	string (date-time)	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

Enumeration

Stellt den Status einer einzelnen Indexerausführung dar.

Wert	Beschreibung
transientFailure	Ein Indexeraufruf ist fehlgeschlagen, aber der Fehler kann vorübergehend sein. Indexeraufrufe werden gemäß dem Zeitplan fortgesetzt.
success	Die Indexerausführung wurde erfolgreich abgeschlossen.
inProgress	Die Ausführung des Indexers wird ausgeführt.
reset	Der Indexer wurde zurückgesetzt.

IndexerExecutionStatusDetail

Enumeration

Gibt den Status einer einzelnen Indexerausführung an.

Wert	Beschreibung
resetDocs	Gibt an, dass die zurückgesetzte Zurücksetzung für einen Aufruf von ResetDocs war.
resync	Gibt an, dass die selektive Neusynchronisierung basierend auf den Optionen aus der Datenquelle erfolgen soll.

IndexerRuntime

Objekt

Stellt den kumulativen Laufzeitverbrauch des Indexers im Dienst dar.

Name	Typ	Beschreibung
beginningTime	string (date-time)	Beginn der UTC-Zeit des Zeitraums von 24 Stunden, der für die Nutzung der Indexerlaufzeit berücksichtigt wird (einschließlich).
endingTime	string (date-time)	End-UTC-Zeit des Zeitraums von 24 Stunden, der für die Nutzung der Indexerlaufzeit berücksichtigt wird (einschließlich).
remainingSeconds	integer (int64)	Kumulative verbleibende Laufzeit für alle Indexer im Dienst von beginningTime bis endingTime in Sekunden.
usedSeconds	integer (int64)	Kumulative Laufzeit des Indexers von beginningTime bis endingTime in Sekunden.

IndexerStatus

Enumeration

Stellt den Gesamtstatus des Indexers dar.

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

IndexingMode

Enumeration

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

Wert	Beschreibung
indexingAllDocs	Der Indexer indiziert alle Dokumente in der Datenquelle.
indexingResetDocs	Der Indexer indiziert selektive Dokumente in der Datenquelle zurück. Die indizierten Dokumente werden für den Indexerstatus definiert.
indexingResync	Der Indexer synchronisiert und indiziert ausgewählte Optionen aus der Datenquelle erneut.

SearchIndexerError

Objekt

Stellt einen Indizierungsfehler auf Element- oder Dokumentebene dar.

Name	Typ	Beschreibung
details	string	Zusätzliche, ausführliche Details zum Fehler, um das Debuggen des Indexers zu unterstützen. 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 bei der Verarbeitung des Elements aufgetreten ist.
key	string	Der Schlüssel des Elements, bei dem die Indizierung fehlgeschlagen ist.
name	string	Der Name der Quelle, von der der Fehler stammt. Dies kann sich beispielsweise auf eine bestimmte Fähigkeit im angehängten Skillset beziehen. Dies ist möglicherweise nicht immer verfügbar.
statusCode	integer (int32)	Der Statuscode, der angibt, warum der Indizierungsvorgang fehlgeschlagen ist. Mögliche Werte sind: 400 für ein fehlerhaftes Eingabedokument, 404 für ein Dokument nicht gefunden, 409 für einen Versionskonflikt, 422, wenn der Index vorübergehend nicht verfügbar ist, oder 503 für den Fall, dass der Dienst zu stark ausgelastet ist.

SearchIndexerLimits

Objekt

Repräsentiert die Grenzwerte, die auf einen Indexer angewendet werden können.

Name	Typ	Beschreibung
maxDocumentContentCharactersToExtract	integer (int64)	Die maximale Anzahl von Zeichen, die aus einem Dokument extrahiert werden, das für die Indizierung ausgewählt wurde.
maxDocumentExtractionSize	integer (int64)	Die maximale Größe eines Dokuments in Bytes, die für die Indizierung als gültig angesehen wird.
maxRunTime	string (duration)	Die maximale Dauer, die der Indexer für eine Ausführung ausführen darf.

SearchIndexerStatus

Objekt

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

Name	Typ	Beschreibung
currentState	IndexerCurrentState	Der gesamte Zustand, der die aktuelle Ausführung des Indexers definiert und diktiert.
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.
name	string	Der Name des Indexers.
runtime	IndexerRuntime	Momentaufnahme des kumulierten Laufzeitverbrauchs des Indexiers für den Dienst im aktuellen UTC-Zeitraum.
status	IndexerStatus	Gesamtindexerstatus.

SearchIndexerWarning

Objekt

Stellt eine Warnung auf Elementebene dar.

Name	Typ	Beschreibung
details	string	Zusätzliche, ausführliche Details zur Warnung, um das Debuggen des Indexers zu unterstützen. 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 ausgelöst 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 eine bestimmte Fähigkeit im angehängten Skillset beziehen. Dies ist möglicherweise nicht immer verfügbar.