Indexers - Get Status

Szolgáltatás:: Search Service

API-verzió:: 2024-09-01-preview

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

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A keresési szolgáltatás végponti URL-címe.
indexerName	path	True	string	Annak az indexelőnek a neve, amelyhez le szeretné kérni az állapotot.
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 kéréssel együtt küldött nyomkövetési azonosító, amely segít a hibakeresésben.

Válaszok

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

Példák

SearchServiceGetIndexerStatus

Mintakérelem

HTTP

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

Mintaválasz

Állapotkó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
  }
}

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	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	Az egyes indexelők végrehajtásának állapotát részletezi.
IndexerStatus	Az indexelő általános állapotát jelöli.
IndexingMode	Azt a módot jelöli, amelyben az indexelő végrehajtja a parancsot.
SearchIndexerError	Elem- vagy dokumentumszintű indexelési hibát jelöl.
SearchIndexerLimits
SearchIndexerStatus	Az indexelőzmények aktuális állapotát és végrehajtási előzményeit jelöli.
SearchIndexerWarning	Elemszintű figyelmeztetést jelöl.

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
allDocsFinalChangeTrackingState	string	Változáskövetési állapotérték, ha az indexelés befejeződik az adatforrás összes dokumentumán.
allDocsInitialChangeTrackingState	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.
resetDocsFinalChangeTrackingState	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.
resetDocsInitialChangeTrackingState	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.

IndexerExecutionResult

Tárgy

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

Name	Típus	Description
currentState	IndexerCurrentState	Az indexelő aktuális végrehajtását meghatározó és diktáló összes állapot.
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.
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ő meghí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 lett állítva.

IndexerExecutionStatusDetail

Felsorolás

Az egyes indexelők végrehajtásának állapotát részletezi.

Érték	Description
resetDocs	Azt jelzi, hogy a visszaállítás a ResetDocs hívásához történt.

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, amelyet emberi beavatkozás nélkül nem lehet kijavítani.
running	Azt jelzi, hogy az indexelő normálisan fut.

IndexingMode

Felsorolás

Azt a módot jelöli, amelyben az indexelő végrehajtja a parancsot.

Érték	Description
indexingAllDocs	Az indexelő az adatforrás összes dokumentumát indexeli.
indexingResetDocs	Az indexelő szelektíven indexeli a dokumentumokat, visszaállítja a dokumentumokat az adatforrásban. Az indexelt dokumentumok az indexelő állapotában vannak definiálva.

SearchIndexerError

Tárgy

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

Name	Típus	Description
details	string	További részletes részletek az indexelő hibakereséséhez nyújtandó hibáról. Előfordulhat, hogy ez nem mindig érhető el.
documentationLink	string	A hibaosztályokhoz tartozó hibaelhárítási útmutatóra mutató hivatkozás. Előfordulhat, hogy ez nem mindig érhető el.
errorMessage	string	Az elem feldolgozása során előforduló 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 egy adott képességre utalhat a csatolt készségkészletben. Előfordulhat, hogy ez nem mindig érhető el.
statusCode	integer (int32)	Az indexelési művelet meghiúsulását jelző állapotkód. A lehetséges értékek a következők: 400 hibás formátumú bemeneti dokumentum esetén, 404 a dokumentum nem található, 409 verzióütközés esetén, 422, ha az index átmenetileg nem érhető el, vagy 503, ha a szolgáltatás túl elfoglalt.

SearchIndexerLimits

Tárgy

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

SearchIndexerStatus

Tárgy

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

Name	Típus	Description
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.
status	IndexerStatus	Az indexelő általános állapota.

SearchIndexerWarning

Tárgy

Elemszintű figyelmeztetést jelöl.

Name	Típus	Description
details	string	További részletes információk a figyelmeztetésről az indexelő hibakereséséhez. Előfordulhat, hogy ez nem mindig érhető el.
documentationLink	string	A figyelmeztetési osztályok hibaelhárítási útmutatójára mutató hivatkozás. Előfordulhat, hogy ez nem mindig érhető el.
key	string	A figyelmeztetést generáló elem kulcsa.
message	string	Az elem feldolgozása során megjelenő figyelmeztetést leíró üzenet.
name	string	Annak a forrásnak a neve, ahonnan a figyelmeztetés származik. Ez például egy adott képességre utalhat a csatolt készségkészletben. Előfordulhat, hogy ez nem mindig érhető el.