Indexers - Get Status

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

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
path True

string (uri)

Adresa URL koncového bodu vyhledávací služby.

indexerName
path True

string

Název indexeru.

api-version
query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name Vyžadováno Typ Description
Accept

Accept

Hlavička Accept.

x-ms-client-request-id

string (uuid)

Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Odpovědi

Name Typ Description
200 OK

SearchIndexerStatus

Požadavek byl úspěšný.

Other Status Codes

ErrorResponse

Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

Name Description
https://search.azure.com/.default

Příklady

SearchServiceGetIndexerStatus
SearchServiceGetS3HDUnlimitedIndexerStatus

SearchServiceGetIndexerStatus

Ukázkový požadavek

GET https://exampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-04-01

Ukázková odpověď

{
  "name": "myindexer",
  "status": "running",
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "errors": [
        {
          "key": "",
          "statusCode": 400,
          "errorMessage": "Document key cannot be missing or empty."
        },
        {
          "key": "document id 1",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "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."
        },
        {
          "key": "document id 2",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "message": "Document was truncated to 50000 characters.",
          "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"
        }
      ]
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  }
}

SearchServiceGetS3HDUnlimitedIndexerStatus

Ukázkový požadavek

GET https://exampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-04-01

Ukázková odpověď

{
  "name": "myindexer",
  "status": "running",
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "errors": [
        {
          "key": "",
          "statusCode": 400,
          "errorMessage": "Document key cannot be missing or empty."
        },
        {
          "key": "document id 1",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "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."
        },
        {
          "key": "document id 2",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "message": "Document was truncated to 50000 characters.",
          "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"
        }
      ]
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  }
}

Definice

Name Description
Accept

Hlavička Accept.

ErrorAdditionalInfo

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

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

IndexerExecutionResult

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

IndexerExecutionStatus

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

IndexerStatus

Představuje celkový stav indexeru.

SearchIndexerError

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

SearchIndexerLimits

Představuje limity, které lze aplikovat na indexer.

SearchIndexerStatus

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

SearchIndexerWarning

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

Accept

Hlavička Accept.

Hodnota Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

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

Name Typ Description
info

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

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name Typ Description
error

ErrorDetail

Objekt chyby.

IndexerExecutionResult

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

Name Typ Description
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.

warnings

SearchIndexerWarning[]

Upozornění indexování na úrovni položek.

IndexerExecutionStatus

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

Hodnota Description
transientFailure

Vyvolání indexeru se nezdařilo, ale selhání může být přechodné. Vyvolání indexeru budou 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.

IndexerStatus

Představuje celkový stav indexeru.

Hodnota Description
unknown

Označuje, že indexer je v neznámém stavu.

error

Označuje, že v indexeru došlo k chybě, kterou nelze opravit bez lidského zásahu.

running

Označuje, že indexer běží normálně.

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

Představuje limity, které lze aplikovat na indexer.

Name Typ Description
maxDocumentContentCharactersToExtract

integer (int64)

Maximální počet znaků, které se extrahují z dokumentu, který se vyzvedne k indexování.

maxDocumentExtractionSize

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

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.

name

string

Název 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.