Indexers - Get Status

Služba:: Search Service

Verze rozhraní API:: 2023-10-01-Preview

Vrátí aktuální stav a historii spuštění indexeru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
indexerName	path	True	string	Název indexeru, pro který se má načíst stav.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	ID sledování odeslané s požadavkem, které vám pomůže s laděním.

Odpovědi

Name	Typ	Description
200 OK	SearchIndexerStatus
Other Status Codes	SearchError	Chybová odpověď.

Příklady

SearchServiceGetIndexerStatus

Ukázkový požadavek

HTTP

GET https://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2023-10-01-Preview

Ukázková odpověď

Stavový kód:: 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
  }
}

Definice

Name	Description
IndexerCurrentState	Představuje veškerý stav, který definuje a určuje aktuální spuštění indexeru.
IndexerExecutionResult	Představuje výsledek spuštění jednotlivých indexerů.
IndexerExecutionStatus	Představuje stav jednotlivých spuštění indexeru.
IndexerExecutionStatusDetail	Podrobně popisuje stav jednotlivých spuštění indexeru.
IndexerStatus	Představuje celkový stav indexeru.
IndexingMode	Představuje režim, ve který indexer provádí.
SearchError	Popisuje chybový stav rozhraní API.
SearchIndexerError	Představuje chybu indexování na úrovni položky nebo dokumentu.
SearchIndexerLimits
SearchIndexerStatus	Představuje aktuální stav a historii spuštění indexeru.
SearchIndexerWarning	Představuje upozornění na úrovni položky.

IndexerCurrentState

Objekt

Představuje veškerý stav, který definuje a určuje aktuální spuštění indexeru.

Name	Typ	Description
allDocsFinalChangeTrackingState	string	Hodnota stavu sledování změn při indexování všech dokumentů ve zdroji dat.
allDocsInitialChangeTrackingState	string	Stav sledování změn použitý při indexování se spustí u všech dokumentů ve zdroji dat.
mode	IndexingMode	Režim, ve kterém je indexer spuštěný.
resetDatasourceDocumentIds	string[]	Seznam ID dokumentu zdroje dat, které byly resetovány. ID dokumentu zdroje dat je jedinečný identifikátor dat ve zdroji dat. Indexer bude selektivně znovu ingestovat tato ID.
resetDocsFinalChangeTrackingState	string	Hodnota stavu sledování změn při indexování vybraného výběru a resetování dokumentů ve zdroji dat.
resetDocsInitialChangeTrackingState	string	Stav sledování změn použitý při indexování při výběru, resetování dokumentů ve zdroji dat.
resetDocumentKeys	string[]	Seznam klíčů dokumentu, které byly resetovány. Klíč dokumentu je jedinečný identifikátor dokumentu pro data v indexu vyhledávání. Indexer bude selektivně znovu ingestovat tyto klíče.

IndexerExecutionResult

Objekt

Představuje výsledek spuštění jednotlivých indexerů.

Name	Typ	Description
currentState	IndexerCurrentState	Veškerý stav, který definuje a určuje aktuální spuštění indexeru.
endTime	string (date-time)	Koncový čas tohoto spuštění indexeru, pokud už bylo spuštění dokončeno.
errorMessage	string	Chybová zpráva označující chybu nejvyšší úrovně( pokud existuje).
errors	SearchIndexerError[]	Chyby indexování na úrovni položek.
finalTrackingState	string	Stav sledování změn, se kterým se dokončilo provádění indexeru
initialTrackingState	string	Stav sledování změn, se kterým se spustilo spuštění indexeru
itemsFailed	integer (int32)	Počet položek, které se nepodařilo indexovat během tohoto spuštění indexeru.
itemsProcessed	integer (int32)	Počet položek zpracovaných během tohoto spuštění indexeru. To zahrnuje úspěšně zpracované položky i položky, ve kterých došlo k pokusu o indexování, ale selhalo.
startTime	string (date-time)	Čas spuštění tohoto indexeru.
status	IndexerExecutionStatus	Výsledek tohoto spuštění indexeru.
statusDetail	IndexerExecutionStatusDetail	Výsledek tohoto spuštění indexeru.
warnings	SearchIndexerWarning[]	Upozornění indexování na úrovni položek.

IndexerExecutionStatus

Výčet

Představuje stav jednotlivých spuštění indexeru.

Hodnota	Description
transientFailure	Vyvolání indexeru se nezdařilo, ale selhání může být přechodné. Vyvolání indexeru bude pokračovat podle plánu.
success	Spuštění indexeru bylo úspěšně dokončeno.
inProgress	Probíhá provádění indexeru.
reset	Indexer byl resetován.

IndexerExecutionStatusDetail

Výčet

Podrobně popisuje stav jednotlivých spuštění indexeru.

Hodnota	Description
resetDocs	Označuje, že resetování, ke kterému došlo, bylo volání ResetDocs.

IndexerStatus

Výčet

Představuje celkový stav indexeru.

Hodnota	Description
unknown	Označuje, že indexer je v neznámém stavu.
error	Označuje, že u indexeru došlo k chybě, která se nedá opravit bez zásahu člověka.
running	Označuje, že indexer běží normálně.

IndexingMode

Výčet

Představuje režim, ve který indexer provádí.

Hodnota	Description
indexingAllDocs	Indexer indexuje všechny dokumenty ve zdroji dat.
indexingResetDocs	Indexer indexuje selektivní a resetuje dokumenty ve zdroji dat. Indexované dokumenty jsou definovány ve stavu indexeru.

SearchError

Objekt

Popisuje chybový stav rozhraní API.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Čitelné znázornění chyby člověkem.

SearchIndexerError

Objekt

Představuje chybu indexování na úrovni položky nebo dokumentu.

Name	Typ	Description
details	string	Další podrobné podrobnosti o chybě, která vám pomůže při ladění indexeru. Nemusí být vždy k dispozici.
documentationLink	string	Odkaz na průvodce odstraňováním potíží pro tyto třídy chyb. Nemusí být vždy k dispozici.
errorMessage	string	Zpráva popisující chybu, ke které došlo při zpracování položky.
key	string	Klíč položky, pro kterou se indexování nezdařilo.
name	string	Název zdroje, ze kterého došlo k chybě. Může to například odkazovat na určitou dovednost v připojené sadě dovedností. Nemusí být vždy k dispozici.
statusCode	integer (int32)	Stavový kód označující, proč operace indexování selhala. Mezi možné hodnoty patří: 400 pro poškozený vstupní dokument, 404 pro dokument nebyl nalezen, 409 pro konflikt verze, 422, pokud je index dočasně nedostupný, nebo 503 pro dobu, kdy je služba příliš zaneprázdněna.

SearchIndexerLimits

Objekt

Name	Typ	Description
maxDocumentContentCharactersToExtract	number (int64)	Maximální počet znaků, které se extrahují z dokumentu, který se vyzvedne k indexování.
maxDocumentExtractionSize	number (int64)	Maximální velikost dokumentu v bajtech, která bude považována za platnou pro indexování.
maxRunTime	string (duration)	Maximální doba trvání, po kterou má indexer povoleno spustit pro jedno spuštění.

SearchIndexerStatus

Objekt

Představuje aktuální stav a historii spuštění indexeru.

Name	Typ	Description
executionHistory	IndexerExecutionResult[]	Historie nedávných spuštění indexeru seřazená v obráceném chronologickém pořadí
lastResult	IndexerExecutionResult	Výsledek posledního nebo probíhajícího spuštění indexeru.
limits	SearchIndexerLimits	Omezení provádění indexeru.
status	IndexerStatus	Celkový stav indexeru

SearchIndexerWarning

Objekt

Představuje upozornění na úrovni položky.

Name	Typ	Description
details	string	Další podrobné podrobnosti o upozornění, které vám pomůžou při ladění indexeru. Nemusí být vždy k dispozici.
documentationLink	string	Odkaz na průvodce odstraňováním potíží pro tyto třídy upozornění. Nemusí být vždy k dispozici.
key	string	Klíč položky, která vygenerovala upozornění.
message	string	Zpráva popisující upozornění, ke kterému došlo při zpracování položky.
name	string	Název zdroje, ze kterého upozornění pochází. Může to například odkazovat na určitou dovednost v připojené sadě dovedností. Nemusí být vždy k dispozici.