Indexers - Get Status

Reference

Služba:: Search Service

Verze rozhraní API:: 2024-07-01

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

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

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	ErrorResponse	Chybová odpověď.

Příklady

SearchServiceGetIndexerStatus

Ukázkový požadavek

HTTP

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

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
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
IndexerExecutionResult	Představuje výsledek spuštění jednotlivých indexerů.
IndexerExecutionStatus	Představuje stav jednotlivých spuštění indexeru.
IndexerStatus	Představuje celkový stav indexeru.
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.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

IndexerExecutionResult

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

Name	Typ	Description
endTime	string	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	Počet položek, které se nepodařilo indexovat během tohoto spuštění indexeru.
itemsProcessed	integer	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	Čas spuštění tohoto indexeru.
status	IndexerExecutionStatus	Výsledek tohoto spuštění indexeru.
warnings	SearchIndexerWarning[]	Upozornění indexování na úrovni položek.

IndexerExecutionStatus

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

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

IndexerStatus

Představuje celkový stav indexeru.

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

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

Name	Typ	Description
maxDocumentContentCharactersToExtract	number	Maximální počet znaků, které se extrahují z dokumentu, který se vyzvedne k 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 trvání, po kterou má indexer povoleno spustit 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	Omezení provádě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 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.

Sdílet prostřednictvím