Indexers - Get Status

Reference

Service:: Search Service

API Version:: 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ý chcete 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é spolu s požadavkem na pomoc s laděním.

Odpovědi

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

Příklady

SearchServiceGetIndexerStatus

Sample Request

HTTP

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

Sample Response

Status code:: 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 všechny stavy, které definují a diktují aktuální spuštění indexeru.
IndexerExecutionResult	Představuje výsledek spuštění jednotlivého indexeru.
IndexerExecutionStatus	Představuje stav spuštění jednotlivého indexeru.
IndexerExecutionStatusDetail	Podrobně popisuje stav spuštění jednotlivého indexeru.
IndexerStatus	Představuje celkový stav indexeru.
IndexingMode	Představuje režim, ve který se indexer spouští.
SearchError	Popisuje chybovou podmínku 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

Představuje všechny stavy, které definují a diktují aktuální spuštění indexeru.

Name	Typ	Description
allDocsFinalChangeTrackingState	string	Změna hodnoty stavu sledování při indexování u všech dokumentů ve zdroji dat
allDocsInitialChangeTrackingState	string	Stav sledování změn použitý při zahájení indexování u všech dokumentů ve zdroji dat.
mode	IndexingMode	Režim, ve kterém indexer běží.
resetDatasourceDocumentIds	string[]	Seznam ID dokumentů 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	Změňte hodnotu stavu sledování po dokončení indexování při výběru, resetujte dokumenty ve zdroji dat.
resetDocsInitialChangeTrackingState	string	Stav sledování změn použitý při indexování při spuštění výběru, resetování dokumentů ve zdroji dat.
resetDocumentKeys	string[]	Seznam klíčů dokumentů, 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

Představuje výsledek spuštění jednotlivého indexeru.

Name	Typ	Description
currentState	IndexerCurrentState	Všechny stavy, které definují a diktují aktuální spuštění indexeru.
endTime	string	Koncový čas spuštění tohoto indexeru, pokud už bylo provádění dokončeno.
errorMessage	string	Chybová zpráva označující chybu nejvyšší úrovně, pokud existuje.
errors	SearchIndexerError[]	Chyby indexování na úrovni položky.
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 začalo provádění indexeru.
itemsFailed	integer	Počet položek, které se během tohoto spuštění indexeru nepodařilo indexovat.
itemsProcessed	integer	Počet položek, které byly zpracovány během tohoto spuštění indexeru. To zahrnuje jak úspěšně zpracované položky, tak položky, u kterých došlo k pokusu o indexování, ale selhalo.
startTime	string	Č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

Představuje stav spuštění jednotlivého indexeru.

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

IndexerExecutionStatusDetail

Podrobně popisuje stav spuštění jednotlivého indexeru.

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

IndexerStatus

Představuje celkový stav indexeru.

Name	Typ	Description
error	string	Označuje, že v indexeru došlo k chybě, kterou nelze opravit bez lidského zásahu.
running	string	Označuje, že indexer běží normálně.
unknown	string	Označuje, že indexer je v neznámém stavu.

IndexingMode

Představuje režim, ve který se indexer spouští.

Name	Typ	Description
indexingAllDocs	string	Indexer indexuje všechny dokumenty ve zdroji dat.
indexingResetDocs	string	Indexer indexuje selektivně, resetuje dokumenty ve zdroji dat. Indexované dokumenty jsou definovány podle stavu indexeru.

SearchError

Popisuje chybovou podmínku rozhraní API.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Lidsky čitelná reprezentace chyby.

SearchIndexerError

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ůžou s laděním 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 chyba pochází. Může to například odkazovat na konkrétní dovednost v připojené sadě dovedností. Nemusí být vždy k dispozici.
statusCode	integer	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, pokud je služba příliš zaneprázdněná.

SearchIndexerLimits

Name	Typ	Description
maxDocumentContentCharactersToExtract	number	Maximální počet znaků, které budou extrahovány z dokumentu vyzvednuty pro indexování.
maxDocumentExtractionSize	number	Maximální velikost dokumentu v bajtech, která bude považována za platnou pro indexování.
maxRunTime	string	Maximální doba, po kterou může indexer běžet pro jedno spuštění.

SearchIndexerStatus

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	Limity spouštění indexeru.
status	IndexerStatus	Celkový stav indexeru

SearchIndexerWarning

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

Name	Typ	Description
details	string	Další podrobné podrobnosti o upozornění, které vám pomůžou s laděním 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 konkrétní dovednost v připojené sadě dovedností. Nemusí být vždy k dispozici.

Sdílet prostřednictvím