Indexers - Get Status

Usługa:: Search Service

Wersja interfejsu API:: 2025-05-01-preview

Zwraca bieżący stan i historię wykonywania indeksatora.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
indexerName	path	True	string	Nazwa indeksatora, dla którego ma być pobierany stan.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Identyfikator śledzenia wysłany z żądaniem, aby ułatwić debugowanie.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SearchIndexerStatus
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchServiceGetIndexerStatus

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "status": "running",
  "lastResult": {
    "status": "success",
    "statusDetail": null,
    "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,
    "mode": "indexingAllDocs"
  },
  "executionHistory": [
    {
      "status": "success",
      "statusDetail": null,
      "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,
      "mode": "indexingAllDocs"
    },
    {
      "status": "transientFailure",
      "statusDetail": null,
      "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,
      "mode": "indexingAllDocs"
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "allDocsInitialTrackingState": null,
    "allDocsFinalTrackingState": null,
    "resetDocsInitialTrackingState": null,
    "resetDocsFinalTrackingState": null,
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": [],
    "resyncInitialTrackingState": null,
    "resyncFinalTrackingState": null
  }
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
IndexerCurrentState	Reprezentuje cały stan, który definiuje i nakazuje bieżące wykonanie indeksatora.
IndexerExecutionResult	Reprezentuje wynik pojedynczego wykonywania indeksatora.
IndexerExecutionStatus	Reprezentuje stan pojedynczego wykonywania indeksatora.
IndexerExecutionStatusDetail	Szczegóły stanu pojedynczego wykonywania indeksatora.
IndexerStatus	Reprezentuje ogólny stan indeksatora.
IndexingMode	Reprezentuje tryb wykonywania indeksatora.
SearchIndexerError	Reprezentuje błąd indeksowania na poziomie elementu lub dokumentu.
SearchIndexerLimits
SearchIndexerStatus	Reprezentuje bieżący stan i historię wykonywania indeksatora.
SearchIndexerWarning	Reprezentuje ostrzeżenie na poziomie elementu.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

IndexerCurrentState

Objekt

Reprezentuje cały stan, który definiuje i nakazuje bieżące wykonanie indeksatora.

Nazwa	Typ	Opis
allDocsFinalTrackingState	string	Wartość stanu śledzenia zmian po zakończeniu indeksowania we wszystkich dokumentach w źródle danych.
allDocsInitialTrackingState	string	Stan śledzenia zmian używany podczas indeksowania rozpoczyna się we wszystkich dokumentach w źródle danych.
mode	IndexingMode	Tryb, w którym jest uruchomiony indeksator.
resetDatasourceDocumentIds	string[]	Lista identyfikatorów dokumentów źródła danych, które zostały zresetowane. Identyfikator dokumentu źródła danych to unikatowy identyfikator danych w źródle danych. Indeksator określi priorytety selektywnie pozyskując te identyfikatory.
resetDocsFinalTrackingState	string	Wartość stanu śledzenia zmian po zakończeniu indeksowania po wybraniu zresetuj dokumenty w źródle danych.
resetDocsInitialTrackingState	string	Stan śledzenia zmian używany podczas indeksowania rozpoczyna się od wybrania, zresetuj dokumenty w źródle danych.
resetDocumentKeys	string[]	Lista kluczy dokumentów, które zostały zresetowane. Klucz dokumentu jest unikatowym identyfikatorem dokumentu dla danych w indeksie wyszukiwania. Indeksator określi priorytety selektywnego ponownego pozyskiwania tych kluczy.
resyncFinalTrackingState	string	Zmień wartość stanu śledzenia po zakończeniu indeksowania w wybranych opcjach ze źródła danych.
resyncInitialTrackingState	string	Zmienianie stanu śledzenia używanego podczas uruchamiania indeksowania w opcjach selektywnych ze źródła danych.

IndexerExecutionResult

Objekt

Reprezentuje wynik pojedynczego wykonywania indeksatora.

Nazwa	Typ	Opis
endTime	string (date-time)	Godzina zakończenia wykonywania indeksatora, jeśli wykonanie zostało już ukończone.
errorMessage	string	Komunikat o błędzie wskazujący błąd najwyższego poziomu, jeśli istnieje.
errors	SearchIndexerError[]	Błędy indeksowania na poziomie elementu.
finalTrackingState	string	Stan śledzenia zmian, za pomocą którego zakończono wykonywanie indeksatora.
initialTrackingState	string	Stan śledzenia zmian, za pomocą którego rozpoczęto wykonywanie indeksatora.
itemsFailed	integer (int32)	Liczba elementów, których nie można indeksować podczas wykonywania indeksatora.
itemsProcessed	integer (int32)	Liczba elementów przetworzonych podczas wykonywania indeksatora. Obejmuje to zarówno pomyślnie przetworzone elementy, jak i elementy, w których podjęto próbę indeksowania, ale nie powiodło się.
mode	IndexingMode	Tryb, w którym jest uruchomiony indeksator.
startTime	string (date-time)	Godzina rozpoczęcia wykonywania indeksatora.
status	IndexerExecutionStatus	Wynik wykonania indeksatora.
statusDetail	IndexerExecutionStatusDetail	Wynik wykonania indeksatora.
warnings	SearchIndexerWarning[]	Ostrzeżenia dotyczące indeksowania na poziomie elementu.

IndexerExecutionStatus

Wyliczenie

Reprezentuje stan pojedynczego wykonywania indeksatora.

Wartość	Opis
transientFailure	Wywołanie indeksatora nie powiodło się, ale błąd może być przejściowy. Wywołania indeksatora będą kontynuowane zgodnie z harmonogramem.
success	Wykonanie indeksatora zakończyło się pomyślnie.
inProgress	Wykonywanie indeksatora jest w toku.
reset	Indeksator został zresetowany.

IndexerExecutionStatusDetail

Wyliczenie

Szczegóły stanu pojedynczego wykonywania indeksatora.

Wartość	Opis
resetDocs	Wskazuje, że zresetowanie, które miało miejsce w przypadku wywołania polecenia ResetDocs.
resync	Wskazuje selektywną ponowną synchronizację na podstawie opcji ze źródła danych.

IndexerStatus

Wyliczenie

Reprezentuje ogólny stan indeksatora.

Wartość	Opis
unknown	Wskazuje, że indeksator jest w nieznanym stanie.
error	Wskazuje, że indeksator napotkał błąd, którego nie można poprawić bez interwencji człowieka.
running	Wskazuje, że indeksator działa normalnie.

IndexingMode

Wyliczenie

Reprezentuje tryb wykonywania indeksatora.

Wartość	Opis
indexingAllDocs	Indeksator indeksuje wszystkie dokumenty w źródle danych.
indexingResetDocs	Indeksator indeksuje selektywnie, resetuje dokumenty w źródle danych. Indeksowane dokumenty są definiowane w stanie indeksatora.
indexingResync	Indeksator ponownie synchronizuje i indeksuje opcje selektywne ze źródła danych.

SearchIndexerError

Objekt

Reprezentuje błąd indeksowania na poziomie elementu lub dokumentu.

Nazwa	Typ	Opis
details	string	Dodatkowe szczegółowe informacje o błędzie ułatwiające debugowanie indeksatora. Może to nie być zawsze dostępne.
documentationLink	string	Link do przewodnika rozwiązywania problemów dla tych klas błędów. Może to nie być zawsze dostępne.
errorMessage	string	Komunikat opisujący błąd, który wystąpił podczas przetwarzania elementu.
key	string	Klucz elementu, dla którego indeksowanie nie powiodło się.
name	string	Nazwa źródła, z którego pochodzi błąd. Na przykład może to odnosić się do konkretnej umiejętności w dołączonym zestawie umiejętności. Może to nie być zawsze dostępne.
statusCode	integer (int32)	Kod stanu wskazujący, dlaczego operacja indeksowania nie powiodła się. Możliwe wartości to: 400 dla źle sformułowanego dokumentu wejściowego, 404 dla dokumentu nie znaleziono, 409 w przypadku konfliktu wersji, 422, gdy indeks jest tymczasowo niedostępny lub 503 w przypadku, gdy usługa jest zbyt zajęta.

SearchIndexerLimits

Objekt

Nazwa	Typ	Opis
maxDocumentContentCharactersToExtract	number (int64)	Maksymalna liczba znaków, które zostaną wyodrębnione z dokumentu pobranego do indeksowania.
maxDocumentExtractionSize	number (int64)	Maksymalny rozmiar dokumentu w bajtach, który będzie uznawany za prawidłowy dla indeksowania.
maxRunTime	string (duration)	Maksymalny czas trwania, przez który indeksator może być uruchamiany dla jednego wykonania.

SearchIndexerStatus

Objekt

Reprezentuje bieżący stan i historię wykonywania indeksatora.

Nazwa	Typ	Opis
currentState	IndexerCurrentState	Cały stan, który definiuje i nakazuje bieżące wykonanie indeksatora.
executionHistory	IndexerExecutionResult[]	Historia ostatnich wykonań indeksatora posortowanych w odwrotnej kolejności chronologicznej.
lastResult	IndexerExecutionResult	Wynik ostatniego lub w toku wykonywania indeksatora.
limits	SearchIndexerLimits	Limity wykonywania indeksatora.
status	IndexerStatus	Ogólny stan indeksatora.

SearchIndexerWarning

Objekt

Reprezentuje ostrzeżenie na poziomie elementu.

Nazwa	Typ	Opis
details	string	Dodatkowe szczegółowe informacje o ostrzeżeniu ułatwiające debugowanie indeksatora. Może to nie być zawsze dostępne.
documentationLink	string	Link do przewodnika rozwiązywania problemów dla tych klas ostrzeżeń. Może to nie być zawsze dostępne.
key	string	Klucz elementu, który wygenerował ostrzeżenie.
message	string	Komunikat opisujący ostrzeżenie, które wystąpiło podczas przetwarzania elementu.
name	string	Nazwa źródła, z którego pochodzi ostrzeżenie. Na przykład może to odnosić się do konkretnej umiejętności w dołączonym zestawie umiejętności. Może to nie być zawsze dostępne.