Indexers - Get Status

Vrátí aktuální stav a historii provádění indexeru.

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2025-11-01-preview

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://previewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2025-11-01-preview

Ukázková odpověď

{
  "name": "myindexer",
  "status": "running",
  "runtime": {
    "usedSeconds": 0,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "mode": "indexingAllDocs",
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "mode": "indexingAllDocs",
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "mode": "indexingAllDocs",
      "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
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": []
  }
}

SearchServiceGetS3HDUnlimitedIndexerStatus

Ukázkový požadavek

GET https://previewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2025-11-01-preview

Ukázková odpověď

{
  "name": "myindexer",
  "status": "running",
  "runtime": {
    "usedSeconds": 0,
    "remainingSeconds": 39600,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "mode": "indexingAllDocs",
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "mode": "indexingAllDocs",
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "mode": "indexingAllDocs",
      "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
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": []
  }
}

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

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 spuštění jednotlivých indexerů.

IndexerExecutionStatusDetail

Podrobnosti o stavu provádění jednotlivých indexerů.

IndexerRuntime

Představuje kumulativní spotřebu indexeru za běhu ve službě.

IndexerStatus

Představuje celkový stav indexeru.

IndexingMode

Představuje režim, ve kterém je indexer spuštěn.

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.

IndexerCurrentState

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

Name Typ Description
allDocsFinalTrackingState

string

Hodnota stavu sledování změn při indexování všech dokumentů ve zdroji dat.

allDocsInitialTrackingState

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.

resetDocsFinalTrackingState

string

Hodnota stavu sledování změn při indexování vybraného výběru a resetování dokumentů ve zdroji dat.

resetDocsInitialTrackingState

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.

resyncFinalTrackingState

string

Změňte hodnotu stavu sledování při dokončení indexování na vybraných možnostech ze zdroje dat.

resyncInitialTrackingState

string

Změňte stav sledování použitý při spuštění indexování na vybraných možnostech ze zdroje dat.

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.

mode

IndexingMode

Režim, ve kterém je indexer spuštěný.

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

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.

IndexerExecutionStatusDetail

Podrobnosti o stavu provádění jednotlivých indexerů.

Hodnota Description
resetDocs

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

resync

Označuje, že se má selektivně znovu synchronizovat na základě možností ze zdroje dat.

IndexerRuntime

Představuje kumulativní spotřebu indexeru za běhu ve službě.

Name Typ Description
beginningTime

string (date-time)

Začátek času UTC 24hodinového období zvažovaného pro použití modulu runtime indexeru (včetně).

endingTime

string (date-time)

Koncový čas UTC 24hodinového období zvažovaného pro použití za běhu indexeru (včetně).

remainingSeconds

integer (int64)

Kumulativní zbývající doba běhu pro všechny indexery ve službě od beginningTime do endingTime v sekundách.

usedSeconds

integer (int64)

Kumulativní doba běhu indexeru od beginningTime do endingTime v sekundách.

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

IndexingMode

Představuje režim, ve kterém je indexer spuštěn.

Hodnota Description
indexingAllDocs

Indexer indexuje všechny dokumenty ve zdroji dat.

indexingResetDocs

Indexer indexuje selektivní, resetuje dokumenty ve zdroji dat. Indexované dokumenty jsou definovány ve stavu indexeru.

indexingResync

Indexer znovu synchronizuje a indexuje selektivní možnosti ze zdroje dat.

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 při ladění indexeru. To nemusí být vždy k dispozici.

documentationLink

string

Odkaz na průvodce odstraňováním potíží s těmito třídami chyb. To 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, u které se indexování nezdařilo.

name

string

Název zdroje, ze kterého chyba pochází. To může například odkazovat na konkrétní dovednost v připojené sadě dovedností. To nemusí být vždy k dispozici.

statusCode

integer (int32)

Stavový kód označující, proč se operace indexování nezdařila. Mezi možné hodnoty patří: 400 pro chybně formátovaný vstupní dokument, 404 pro nenalezený dokument, 409 pro konflikt verzí, 422, když je index dočasně nedostupný, nebo 503 pro případ, že je služba příliš zaneprázdněná.

SearchIndexerLimits

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

Name Typ Description
maxDocumentContentCharactersToExtract

integer (int64)

Maximální počet znaků, které budou extrahovány z dokumentu vybraného 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, 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
currentState

IndexerCurrentState

Veškerý stav, který definuje a diktuje aktuální provádění indexeru.

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.

runtime

IndexerRuntime

Snímek kumulativní spotřeby běhu služby indexerem za aktuální UTC období.

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. To nemusí být vždy k dispozici.

documentationLink

string

Odkaz na průvodce odstraňováním potíží pro tyto třídy upozornění. To nemusí být vždy k dispozici.

key

string

Klíč položky, která vygenerovala varová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í. To může například odkazovat na konkrétní dovednost v připojené sadě dovedností. To nemusí být vždy k dispozici.