Indexers - Get Status

Referencia

Szolgáltatás:: Search Service

API-verzió:: 2023-11-01

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=2023-11-01

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 az állapotot le szeretné 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 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	SearchError	Hibaválasz.

Példák

SearchServiceGetIndexerStatus

Mintakérelem

HTTP

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

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
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.
IndexerStatus	Az indexelő általános állapotát jelöli.
SearchError	Az API hibafeltételét ismerteti.
SearchIndexerError	Elem- vagy dokumentumszintű indexelési hibát jelöl.
SearchIndexerLimits
SearchIndexerStatus	Egy indexelőzmény aktuális állapotát és végrehajtási előzményeit jelöli.
SearchIndexerWarning	Elemszintű figyelmeztetést jelöl.

IndexerExecutionResult

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

Name	Típus	Description
endTime	string	Az indexelő végrehajtásának vége, 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	Az indexelő végrehajtása során nem indexelhető elemek száma.
itemsProcessed	integer	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	Az indexelő végrehajtásának kezdő időpontja.
status	IndexerExecutionStatus	Az indexelő végrehajtásának eredménye.
warnings	SearchIndexerWarning[]	Az elemszintű indexelési figyelmeztetések.

IndexerExecutionStatus

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

Name	Típus	Description
inProgress	string	Az indexelő végrehajtása folyamatban van.
reset	string	Az indexelő alaphelyzetbe lett állítva.
success	string	Az indexelő végrehajtása sikeresen befejeződött.
transientFailure	string	Az indexelő meghívása sikertelen volt, de a hiba átmeneti lehet. Az indexelő hívásai ütemezés szerint folytatódnak.

IndexerStatus

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

Name	Típus	Description
error	string	Azt jelzi, hogy az indexelő olyan hibát észlelt, amely emberi beavatkozás nélkül nem javítható ki.
running	string	Azt jelzi, hogy az indexelő normálisan fut.
unknown	string	Azt jelzi, hogy az indexelő ismeretlen állapotban van.

SearchError

Az API hibafeltételét ismerteti.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	SearchError[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.

SearchIndexerError

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

Name	Típus	Description
details	string	További részletes részletek a hibáról az indexelő hibakereséséhez. Lehet, hogy ez nem mindig érhető el.
documentationLink	string	A hibaosztályokhoz tartozó hibaelhárítási útmutatóra mutató hivatkozás. Lehet, 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épességcsoportban. Lehet, hogy ez nem mindig érhető el.
statusCode	integer	Az indexelési művelet meghiúsulását jelző állapotkód. Lehetséges értékek: 400 helytelen formátumú bemeneti dokumentum esetén, 404 a dokumentum nem található, 409 verzióütközés, 422, ha az index átmenetileg nem érhető el, vagy 503, ha a szolgáltatás túl elfoglalt.

SearchIndexerLimits

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

SearchIndexerStatus

Egy indexelőzmény 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

Elemszintű figyelmeztetést jelöl.

Name	Típus	Description
details	string	További részletes részletek a figyelmeztetésről az indexelő hibakereséséhez. Lehet, hogy ez nem mindig érhető el.
documentationLink	string	Az alábbi figyelmeztetési osztályok hibaelhárítási útmutatójára mutató hivatkozás. Lehet, 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épességcsoportban. Lehet, hogy ez nem mindig érhető el.

Megosztás a következőn keresztül: