Indexers - Get Status

Szolgáltatás:: Search Service

API-verzió:: 2025-08-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-08-01-preview

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A keresési szolgáltatás végpontjának URL-címe.
indexerName	path	True	string	Annak az indexelőnek a neve, amelynek állapotát le kell kérni.
api-version	query	True	string	Ügyfél API verziója.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A hibakeresési kérelemmel küldött nyomkövetési azonosító.

Válaszok

Name	Típus	Description
200 OK	SearchIndexerStatus
Other Status Codes	ErrorResponse	Hibaválasz.

Példák

SearchServiceGetIndexerStatus

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 200

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

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
IndexerCurrentState	Az indexelő aktuális végrehajtását meghatározó és diktáló összes állapotot jelöli.
IndexerExecutionResult	Egy egyedi indexelő 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.
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
SearchIndexerStatus	Az indexelő aktuális állapotát és végrehajtási előzményeit jelöli.
SearchIndexerWarning	Elemszintű figyelmeztetést jelent.

ErrorAdditionalInfo

Tárgy

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

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	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

Hibaválasz

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

Name	Típus	Description
allDocsFinalTrackingState	string	Módosítsa a nyomkövetési állapot értékét, amikor az indexelés befejeződik az adatforrás összes dokumentumán.
allDocsInitialTrackingState	string	Az indexelés megkezdésekor használt követési állapot módosítása az adatforrás összes dokumentumán.
mode	IndexingMode	Az indexelő üzemmódja.
resetDatasourceDocumentIds	string[]	Az alaphelyzetbe állított adatforrás-dokumentumazonosítók listája. Az adatforrás-dokumentum azonosítója az adatforrásban lévő adatok egyedi azonosítója. Az indexelő prioritásként kezeli az azonosítók szelektív újbóli betöltését.
resetDocsFinalTrackingState	string	Módosítsa a nyomkövetési állapot értékét, amikor az indexelés befejeződik az adatforrás dokumentumainak kiválasztásakor, állítsa alaphelyzetbe a dokumentumokat.
resetDocsInitialTrackingState	string	Az indexelés megkezdésekor használt nyomkövetési állapot módosítása az adatforrás dokumentumainak kiválasztása, alaphelyzetbe állítása.
resetDocumentKeys	string[]	Az alaphelyzetbe állított dokumentumkulcsok listája. A dokumentumkulcs a dokumentum egyedi azonosítója a keresési indexben szereplő adatokhoz. Az indexelő prioritásként kezeli a kulcsok szelektív újbóli betöltését.
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

Egy egyedi indexelő végrehajtásának eredményét jelöli.

Name	Típus	Description
endTime	string (date-time)	Az indexelő végrehajtásának befejezési ideje, 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	Módosítsa a nyomon követési állapotot, amellyel az indexelő végrehajtása befejeződött.
initialTrackingState	string	Módosítsa a követési állapotot, amellyel az indexelő végrehajtása elindult.
itemsFailed	integer (int32)	Az indexelő végrehajtása során nem sikerült indexelni kívánt elemek száma.
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, amelyeken az indexelést megkísérelték, de sikertelen volt.
mode	IndexingMode	Az indexelő üzemmódja.
startTime	string (date-time)	Az indexelő végrehajtásának kezdési 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ára vonatkozott.
resync	Azt jelzi, hogy szelektíven újraszinkronizálja az adatforrásból származó lehetőség(ek) alapján.

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ő állapota alapján vannak meghatározva.
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.

Name	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

Name	Típus	Description
maxDocumentContentCharactersToExtract	number (int64)	Az indexelésre felvett dokumentumból kinyert karakterek maximális száma.
maxDocumentExtractionSize	number (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ő aktuális állapotát és végrehajtási előzményeit jelöli.

Name	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ő kivégzések története, 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.
status	IndexerStatus	Általános indexelő állapota.

SearchIndexerWarning

Tárgy

Elemszintű figyelmeztetést jelent.

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