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

Indexelő állapotának lekérése (Azure AI Search REST API)

  • Cikk

Az Indexelő állapotának lekérése művelet lekéri egy indexelőzmény aktuális állapotát és végrehajtási előzményeit:

GET https://[service name].search.windows.net/indexers/[indexer name]/status?api-version=[api-version]&failIfCannotDecrypt=[true|false]
  Content-Type: application/json  
  api-key: [admin key]

URI-paraméterek

Paraméter Leírás
szolgáltatásnév Kötelező. Állítsa be ezt a keresési szolgáltatás egyedi, felhasználó által megadott nevére.
indexelő neve Kötelező. A kérelem URI-ja megadja annak az indexelőnek a nevét, amelynek az állapotát vissza kell adni.
api-verzió Kötelező. A jelenlegi stabil verzió a következő api-version=2020-06-30: . További verziókért lásd: API-verziók .
failIfCannotDecrypt Nem kötelező, alapértelmezés szerint igaz, ha nincs megadva. Ha az indexelő titkosítási kulccsal lett létrehozva, és a keresési szolgáltatás nem rendelkezik hozzáféréssel a titkosítási kulcshoz, az indexelő állapotának lekérése sikertelen lesz. Ha hamis, az indexelő visszaadott állapota helyőrzőkre cserélte a "<encrypted>" titkosított tulajdonságokat.

Kérelemfejlécek

Az alábbi táblázat a szükséges és nem kötelező kérelemfejléceket ismerteti.

Mezők Description
Content-Type Kötelező. Állítsa ezt a következőre: application/json
api-key Nem kötelező , ha Azure-szerepköröket használ, és egy tulajdonosi jogkivonatot ad meg a kéréshez, ellenkező esetben kulcsra van szükség. Az API-kulcs egy egyedi, rendszer által létrehozott sztring, amely hitelesíti a keresési szolgáltatásnak küldött kérést. Az objektumdefiníciók kéréseinek tartalmazniuk kell a rendszergazdai kulcsra beállított API-kulcs mezőt (a lekérdezési kulcs helyett). A részletekért lásd: Csatlakozás az Azure AI Searchhöz kulcshitelesítés használatával .

Kérelem törzse

Nincsenek.

Reagálás

Állapotkód: 200 OK a sikeres válaszhoz. A válasz törzse információkat tartalmaz az indexelő általános állapotáról, az utolsó indexelőhívásról és a legutóbbi indexelőhívások előzményeiről (ha van ilyen).

A mintaválasz törzse így néz ki:

{
    "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" : "",
                    "name" : "The operation name describing where the error occurred. For example, 'Enrichment.LanguageDetectionSkill.SkillName'",
                    "errorMessage" : "Document key cannot be missing or empty.",
                    "statusCode" : 400,
                    "details" : "Any additional details, such as the WebApi response if executing a custom skill failed.",
                    "documentationLink" : "A link to relevant documentation. For example, 'https://go.microsoft.com/fwlink/?linkid=2099692'""
                }
            ],
            "warnings" : [
                {
                    "key" : "document id",
                    "name" : "The operation name describing where the warning occurred. For example, 'Enrichment.LanguageDetectionSkill.SkillName'",
                    "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."
                    "details" : "Any additional details, such as the WebApi response if executing a custom skill failed.",
                    "documentationLink" : "A link to relevant documentation. For example, 'https://go.microsoft.com/fwlink/?linkid=2099692'"
                }
            ],
            "itemsProcessed" : 1,
            "itemsFailed" : 1,
            "initialTrackingState" : null,
            "finalTrackingState" : null
        }
    ]
}

Megjegyzés

Ha az indexelő titkosítási kulccsal lett létrehozva, az állapot titkosított tulajdonságai csak akkor kérhetők le, ha a keresési szolgáltatás hozzáfér a titkosítási kulcshoz. Ha a keresési szolgáltatás nem fér hozzá a titkosítási kulcshoz, a rendszer alapértelmezés szerint 400 hibás kérést ad vissza. Adja meg failIfCannotDecrypt=false , hogy a titkosított tulajdonságokat lecserélő helyőrzőkkel "<encrypted>" szeretné lekérni az állapotot.

Indexelő állapota

Az indexelő állapota a következő értékek egyike lehet:

  • A running azt jelzi, hogy az indexelő a szokásos módon fut. Előfordulhat, hogy az indexelő egyes végrehajtásai továbbra is sikertelenek, ezért érdemes ellenőrizni a lastResult tulajdonságot is.

  • hiba azt jelzi, hogy az indexelő olyan hibát észlelt, amely emberi beavatkozás nélkül nem javítható ki. Előfordulhat például, hogy az adatforrás hitelesítő adatai lejártak, vagy az adatforrás vagy a célindex sémája kompatibilitástörő módon megváltozott.

Indexelő végrehajtási eredménye

Az indexelő végrehajtási eredményei egyetlen indexelő végrehajtásával kapcsolatos információkat tartalmaznak. A legújabb eredmény az indexelő állapotának lastResult tulajdonságaként jelenik meg. A rendszer az indexelő állapotának executionHistory tulajdonságaként adja vissza a legutóbbi eredményeket, ha vannak ilyenek.

Az indexelő végrehajtási eredménye a következő tulajdonságokat tartalmazza:

  • status: A végrehajtás állapota. További részletekért lásd az indexelő végrehajtási állapotát ismertető szakaszt.

  • errorMessage: Sikertelen végrehajtás esetén megjelenő hibaüzenet.

  • startTime: A végrehajtás megkezdésének időpontja UTC-ben.

  • endTime: A végrehajtás befejezésének időpontja UTC-ben. Ez az érték nincs beállítva, ha a végrehajtás még folyamatban van.

  • hibák: Elemszintű hibák listája, ha vannak ilyenek. Példaként tekintse meg a fenti mintaválaszt. Az API-verziótól 2020-06-30 kezdődően a listában szereplő összes hiba már nem fog szerepelni "status" , mert az elemszintű hibák esetében mindig hamis volt. Az API-verziótól 2020-06-30kezdve a listában szereplő összes hiba tartalmazza az új tulajdonságokat "name", "details"és "documentationLink".

  • figyelmeztetések: Elemszintű figyelmeztetések listája, ha vannak ilyenek. Példaként tekintse meg a fenti mintaválaszt. Az API-verziótól 2020-06-30kezdve a listában szereplő összes figyelmeztetés tartalmazza az új tulajdonságokat "name", "details"és "documentationLink".

  • itemsProcessed(Feldolgozott elemek): Azon adatforráselemek (például táblasorok) száma, amelyeket az indexelő a végrehajtás során indexelni próbált.

  • itemsFailed: A végrehajtás során sikertelen elemek száma. A hiba a sikertelen elem azonosítóját adja meg.

  • initialTrackingState: Mindig null értékű az indexelő első végrehajtásakor, vagy ha az adatváltozás-követési szabályzat nincs engedélyezve a használt adatforráson. Ha egy ilyen szabályzat engedélyezve van, a későbbi végrehajtásokban ez az érték a végrehajtás által feldolgozott első (legalacsonyabb) változáskövetési értéket jelzi.

  • finalTrackingState: Mindig null értékű, ha az adatváltozás-követési szabályzat nincs engedélyezve a használt adatforráson. Ellenkező esetben a legutóbbi (legmagasabb) változáskövetési értéket jelzi, amelyet a végrehajtás sikeresen feldolgoz.

Indexelő végrehajtási állapota

Az indexelő végrehajtási állapota egyetlen indexelő-végrehajtás állapotát rögzíti. A következő értékeket veheti fel:

  • A success azt jelzi, hogy az indexelő végrehajtása sikeresen befejeződött.

  • Az inProgress azt jelzi, hogy az indexelő végrehajtása folyamatban van.

  • A transientFailure azt jelzi, hogy az indexelő végrehajtása sikertelen volt. A részletekért tekintse meg az errorMessage tulajdonságot. Előfordulhat, hogy a hiba kijavításához emberi beavatkozás szükséges vagy nem szükséges. Az adatforrás és a célindex közötti sémakompatibilitás javításához például felhasználói beavatkozásra van szükség, míg az adatforrás ideiglenes leállása nem. Az indexelőhívások ütemezésenként folytatódnak, ha van definiálva. Ha egy ütemezésben lévő indexelő többször is elér egy átmenetiFailure állapotot előrehaladás nélkül, az indexelő ritkábban (legfeljebb 24 óránként egyszer) fog futni, amíg újra sikeresen nem halad.

  • A persistentFailure azt jelzi, hogy az indexelő emberi beavatkozást igénylő módon meghiúsult. Az ütemezett indexelő-végrehajtások leállnak. A probléma megoldása után az Indexelő alaphelyzetbe állítása (Azure AI Search REST API) használatával indítsa újra az ütemezett végrehajtásokat.

  • A reset azt jelzi, hogy az indexelőt alaphelyzetbe állította az Indexelő alaphelyzetbe állítása (Azure AI Search REST API) hívása.

Lásd még