Indexers - Get Status

Szolgáltatás:: Search Service

API-verzió:: 2025-11-01-preview

Egy indexelő aktuális állapotát és végrehajtási előzményeit adja vissza.

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

URI-paraméterek

Név	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A keresési szolgáltatás végpontjának URL-címe.
indexerName	path	True	string	Az indexelő neve.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérelem fejléce

Név	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.
Accept		Accept	Az Elfogadás fejléce.

Válaszok

Név	Típus	Description
200 OK	SearchIndexerStatus	A kérés sikeres volt.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

api-key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Hatókörök

Név	Description
https://search.azure.com/.default

Példák

SearchServiceGetIndexerStatus

SearchServiceGetS3HDUnlimitedIndexerStatus

SearchServiceGetIndexerStatus

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 200

{
  "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

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 200

{
  "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": []
  }
}

Definíciók

Név	Description
Accept	Az Elfogadás fejléce.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
IndexerCurrentState	Az indexelő aktuális végrehajtását meghatározó és diktáló összes állapotot jelöli.
IndexerExecutionResult	Az egyes indexelők végrehajtásának eredményét jelöli.
IndexerExecutionStatus	Az egyes indexelők végrehajtásának állapotát jelöli.
IndexerExecutionStatusDetail	Részletezi az egyes indexelők végrehajtásának állapotát.
IndexerRuntime	Az indexelő összesített futásidejű felhasználását jelöli a szolgáltatásban.
IndexerStatus	Az indexelő általános állapotát jelöli.
IndexingMode	Az indexelő által végrehajtott módot jelöli.
SearchIndexerError	Elem- vagy dokumentumszintű indexelési hibát jelöl.
SearchIndexerLimits	A korlátokat jelöli, amelyek az indexelőre alkalmazhatók.
SearchIndexerStatus	Az indexelőzmények aktuális állapotát és végrehajtási előzményeit jelöli.
SearchIndexerWarning	Elemszintű figyelmeztetést jelöl.

Accept

Felsorolás

Az Elfogadás fejléce.

Érték	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Név	Típus	Description
info		A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Név	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Tárgy

Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Név	Típus	Description
error	ErrorDetail	A hibaobjektum.

IndexerCurrentState

Tárgy

Az indexelő aktuális végrehajtását meghatározó és diktáló összes állapotot jelöli.

Név	Típus	Description
allDocsFinalTrackingState	string	Változáskövetési állapotérték, ha az indexelés befejeződik az adatforrás összes dokumentumán.
allDocsInitialTrackingState	string	Változáskövetési állapot, amelyet az indexelés indításakor használnak az adatforrás összes dokumentumán.
mode	IndexingMode	Az indexelő által használt üzemmód.
resetDatasourceDocumentIds	string[]	A visszaállított adatforrás-dokumentumazonosítók listája. Az adatforrás dokumentumazonosítója az adatforrásban lévő adatok egyedi azonosítója. Az indexelő előnyben részesíti az azonosítók szelektív újrabetöltését.
resetDocsFinalTrackingState	string	Módosítsa a nyomkövetési állapot értékét, amikor az indexelés befejeződött a kiválasztáskor, állítsa alaphelyzetbe a dokumentumokat az adatforrásban.
resetDocsInitialTrackingState	string	Az indexelés indításakor használt változáskövetési állapot kiválasztásakor, a dokumentumok alaphelyzetbe állítása az adatforrásban.
resetDocumentKeys	string[]	A visszaállított dokumentumkulcsok listája. A dokumentumkulcs a dokumentum egyedi azonosítója a keresési indexben lévő adatokhoz. Az indexelő a kulcsok szelektív újrabetöltését rangsorolja.
resyncFinalTrackingState	string	Módosítsa a nyomkövetési állapot értékét, amikor az indexelés befejeződik az adatforrás szelektív beállításaival.
resyncInitialTrackingState	string	Az indexelés indításakor használt követési állapot módosítása az adatforrás szelektív beállításain.

IndexerExecutionResult

Tárgy

Az egyes indexelők végrehajtásának eredményét jelöli.

Név	Típus	Description
endTime	string (date-time)	Az indexelő végrehajtásának befejezési időpontja, ha a végrehajtás már befejeződött.
errorMessage	string	A legfelső szintű hibát jelző hibaüzenet, ha van ilyen.
errors	SearchIndexerError[]	Az elemszintű indexelési hibák.
finalTrackingState	string	Változáskövetési állapot, amellyel az indexelő végrehajtása befejeződött.
initialTrackingState	string	Változáskövetési állapot, amellyel egy indexelő végrehajtása elindult.
itemsFailed	integer (int32)	Azon elemek száma, amelyeket az indexelő végrehajtása során nem sikerült indexelni.
itemsProcessed	integer (int32)	Az indexelő végrehajtása során feldolgozott elemek száma. Ez magában foglalja a sikeresen feldolgozott elemeket és azokat az elemeket is, ahol az indexelést megkísérelték, de sikertelenek.
mode	IndexingMode	Az indexelő által használt üzemmód.
startTime	string (date-time)	Az indexelő végrehajtásának kezdő időpontja.
status	IndexerExecutionStatus	Az indexelő végrehajtásának eredménye.
statusDetail	IndexerExecutionStatusDetail	Az indexelő végrehajtásának eredménye.
warnings	SearchIndexerWarning[]	Az elemszintű indexelési figyelmeztetések.

IndexerExecutionStatus

Felsorolás

Az egyes indexelők végrehajtásának állapotát jelöli.

Érték	Description
transientFailure	Az indexelő hívása sikertelen volt, de a hiba átmeneti lehet. Az indexelő hívásai ütemezés szerint folytatódnak.
success	Az indexelő végrehajtása sikeresen befejeződött.
inProgress	Az indexelő végrehajtása folyamatban van.
reset	Az indexelő alaphelyzetbe állt.

IndexerExecutionStatusDetail

Felsorolás

Részletezi az egyes indexelők végrehajtásának állapotát.

Érték	Description
resetDocs	Azt jelzi, hogy a visszaállítás a ResetDocs hívásához történt.
resync	Azt jelzi, hogy szelektíven újraszinkronizálja az adatforrásból származó lehetőség(ek) alapján.

IndexerRuntime

Tárgy

Az indexelő összesített futásidejű felhasználását jelöli a szolgáltatásban.

Név	Típus	Description
beginningTime	string (date-time)	Az indexelő futtatókörnyezet használatához figyelembe vett 24 órás időszak kezdő UTC-ideje (beleértve).
endingTime	string (date-time)	Az indexelő futtatókörnyezet használatához figyelembe vett 24 órás időszak UTC-idejének vége (beleértve).
remainingSeconds	integer (int64)	A szolgáltatás összes indexelője számára fennmaradó összesített futtatókörnyezet a beginningTime és az endingTime között, másodpercben.
usedSeconds	integer (int64)	Az indexelő összesített futtatókörnyezete a beginningTime és az endingTime között, másodpercben.

IndexerStatus

Felsorolás

Az indexelő általános állapotát jelöli.

Érték	Description
unknown	Azt jelzi, hogy az indexelő ismeretlen állapotban van.
error	Azt jelzi, hogy az indexelő olyan hibát észlelt, amely emberi beavatkozás nélkül nem javítható ki.
running	Azt jelzi, hogy az indexelő megfelelően fut.

IndexingMode

Felsorolás

Az indexelő által végrehajtott módot jelöli.

Érték	Description
indexingAllDocs	Az indexelő indexeli az adatforrás összes dokumentumát.
indexingResetDocs	Az indexelő szelektív, alaphelyzetbe állított dokumentumokat indexel az adatforrásban. Az indexelt dokumentumok az indexelő állapotában vannak definiálva.
indexingResync	Az indexelő újraszinkronizálja és indexeli az adatforrásból származó szelektív beállítás(oka)t.

SearchIndexerError

Tárgy

Elem- vagy dokumentumszintű indexelési hibát jelöl.

Név	Típus	Description
details	string	A hiba további, részletes részletei az indexelő hibakeresésének elősegítéséhez. Előfordulhat, hogy ez nem mindig áll rendelkezésre.
documentationLink	string	Hivatkozás az ilyen hibaosztályok hibaelhárítási útmutatójára. Előfordulhat, hogy ez nem mindig áll rendelkezésre.
errorMessage	string	Az elem feldolgozása során bekövetkezett hibát leíró üzenet.
key	string	Annak az elemnek a kulcsa, amelynek indexelése sikertelen volt.
name	string	Annak a forrásnak a neve, ahonnan a hiba származik. Ez például a csatolt képességkészlet egy adott képességére utalhat. Előfordulhat, hogy ez nem mindig áll rendelkezésre.
statusCode	integer (int32)	Az indexelési művelet sikertelenségét jelző állapotkód. A lehetséges értékek a következők: 400 hibásan formázott bemeneti dokumentum esetén, 404 a nem található dokumentum esetén, 409 verzióütközés esetén, 422, ha az index átmenetileg nem érhető el, vagy 503, ha a szolgáltatás túl foglalt.

SearchIndexerLimits

Tárgy

A korlátokat jelöli, amelyek az indexelőre alkalmazhatók.

Név	Típus	Description
maxDocumentContentCharactersToExtract	integer (int64)	Az indexelésre felvett dokumentumból kinyert karakterek maximális száma.
maxDocumentExtractionSize	integer (int64)	A dokumentum maximális mérete bájtban, amely érvényesnek minősül az indexeléshez.
maxRunTime	string (duration)	Az indexelő által egy végrehajtáshoz engedélyezett maximális időtartam.

SearchIndexerStatus

Tárgy

Az indexelőzmények aktuális állapotát és végrehajtási előzményeit jelöli.

Név	Típus	Description
currentState	IndexerCurrentState	Az indexelő aktuális végrehajtását meghatározó és diktáló állapot összessége.
executionHistory	IndexerExecutionResult[]	A legutóbbi indexelővégrehajtások előzményei fordított időrendi sorrendben rendezve.
lastResult	IndexerExecutionResult	A legutóbbi vagy folyamatban lévő indexelő végrehajtásának eredménye.
limits	SearchIndexerLimits	Az indexelő végrehajtási korlátai.
name	string	Az indexelő neve.
runtime	IndexerRuntime	Az indexelő szolgáltatás összes futási idejű fogyasztásának pillanatképe a jelenlegi UTC időszakban.
status	IndexerStatus	Az indexelő általános állapota.

SearchIndexerWarning

Tárgy

Elemszintű figyelmeztetést jelöl.

Név	Típus	Description
details	string	További, részletes részletek a figyelmeztetésről, amelyek segítenek az indexelő hibakeresésében. Előfordulhat, hogy ez nem mindig áll rendelkezésre.
documentationLink	string	A figyelmeztetések ezen osztályainak hibaelhárítási útmutatójára mutató hivatkozás. Előfordulhat, hogy ez nem mindig áll rendelkezésre.
key	string	A figyelmeztetést generáló elem kulcsa.
message	string	Az elem feldolgozása során történt figyelmeztetést leíró üzenet.
name	string	Annak a forrásnak a neve, ahonnan a figyelmeztetés származik. Ez például a csatolt képességkészlet egy adott képességére utalhat. Előfordulhat, hogy ez nem mindig áll rendelkezésre.