Indexers - Get Status

Odwołanie

Usługa:: Search Service

Wersja interfejsu API:: 2024-07-01

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

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2024-07-01

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=2024-07-01

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
IndexerExecutionResult	Reprezentuje wynik pojedynczego wykonywania indeksatora.
IndexerExecutionStatus	Reprezentuje stan pojedynczego wykonywania indeksatora.
IndexerStatus	Reprezentuje ogólny stan 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

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

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

ErrorDetail

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

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

IndexerExecutionResult

Reprezentuje wynik pojedynczego wykonywania indeksatora.

Nazwa	Typ	Opis
endTime	string	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	Liczba elementów, których nie można indeksować podczas wykonywania indeksatora.
itemsProcessed	integer	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ę.
startTime	string	Godzina rozpoczęcia wykonywania indeksatora.
status	IndexerExecutionStatus	Wynik wykonania indeksatora.
warnings	SearchIndexerWarning[]	Ostrzeżenia dotyczące indeksowania na poziomie elementu.

IndexerExecutionStatus

Reprezentuje stan pojedynczego wykonywania indeksatora.

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

IndexerStatus

Reprezentuje ogólny stan indeksatora.

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

SearchIndexerError

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

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

SearchIndexerStatus

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

Nazwa	Typ	Opis
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

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.

Udostępnij za pośrednictwem