Získání stavu indexeru (rozhraní REST API služby Azure AI Search)
Operace Získání stavu indexeru načte aktuální stav a historii spuštění indexeru:
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]
Parametry identifikátoru URI
| Parametr | Popis |
|---|---|
| název služby | Povinná hodnota. Nastavte ho na jedinečný uživatelsky definovaný název vaší vyhledávací služby. |
| název indexeru | Povinná hodnota. Identifikátor URI požadavku určuje název indexeru, pro který se má vrátit stav. |
| verze-api | Povinná hodnota. Aktuální stabilní verze je api-version=2020-06-30. Další verze najdete v tématu Verze rozhraní API . |
| failIfCannotDecrypt | Volitelné, výchozí hodnota je true, pokud není zadána. Pokud byl indexer vytvořen pomocí šifrovacího klíče a vyhledávací služba nemá přístup k šifrovacímu klíči, načtení stavu indexeru se nezdaří. Pokud je false, vrácený stav indexeru má zašifrované vlastnosti nahrazené zástupnými "<encrypted>" symboly. |
Hlavičky požadavku
Následující tabulka popisuje požadované a volitelné hlavičky požadavků.
| Pole | Description |
|---|---|
| Typ obsahu | Povinná hodnota. Nastavte tuto možnost na application/json |
| api-key | Volitelné, pokud používáte role Azure a v požadavku je k dispozici nosný token, jinak se vyžaduje klíč. Klíč api-key je jedinečný systémově vygenerovaný řetězec, který ověřuje požadavek pro vaši vyhledávací službu. Požadavky na získání definice objektu musí obsahovat pole api-key nastavené na klíč správce (na rozdíl od klíče dotazu). Podrobnosti najdete v tématu Připojení ke službě Azure AI Search pomocí ověřování pomocí klíče . |
Text požadavku
Žádné
Odpověď
Stavový kód: 200 OK pro úspěšnou odpověď. Text odpovědi obsahuje informace o celkovém stavu indexeru, posledním vyvolání indexeru a historii nedávných volání indexeru (pokud je k dispozici).
Tělo ukázkové odpovědi vypadá takto:
{
"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
}
]
}
Poznámka
Pokud byl indexer vytvořen pomocí šifrovacího klíče, je možné načíst šifrované vlastnosti stavu pouze v případě, že má vyhledávací služba přístup k šifrovacímu klíči. Pokud vyhledávací služba nemá přístup k šifrovacímu klíči, vrátí se ve výchozím nastavení chybný požadavek 400. Zadejte failIfCannotDecrypt=false , pokud chcete načíst stav zástupnými "<encrypted>" symboly, které nahradí šifrované vlastnosti.
Stav indexeru
Stav indexeru může být jedna z následujících hodnot:
running označuje, že indexer běží normálně. Některá spuštění indexeru můžou stále selhávající, takže je vhodné zkontrolovat také vlastnost lastResult .
error označuje, že v indexeru došlo k chybě, kterou nelze opravit bez zásahu člověka. Vypršela například platnost přihlašovacích údajů ke zdroji dat nebo se změnilo schéma zdroje dat nebo cílového indexu.
Výsledek spuštění indexeru
Výsledek spuštění indexeru obsahuje informace o spuštění jednoho indexeru. Poslední výsledek se zobrazí jako vlastnost lastResult stavu indexeru. Další nedávné výsledky, pokud jsou k dispozici, jsou vráceny jako vlastnost executionHistory stavu indexeru.
Výsledek spuštění indexeru obsahuje následující vlastnosti:
status: Stav spuštění. Podrobnosti najdete níže v tématu Stav spuštění indexeru .
errorMessage: Chybová zpráva pro neúspěšné spuštění.
startTime: Čas ve standardu UTC, kdy se toto spuštění spustilo.
endTime: Čas v UTC, kdy bylo toto spuštění ukončeno. Tato hodnota není nastavená, pokud provádění stále probíhá.
errors: Seznam chyb na úrovni položek, pokud existují. Příklad najdete v ukázkové odpovědi výše. Počínaje verzí
2020-06-30rozhraní API už nebude každá chyba v seznamu obsahovat chybu"status", protože pro chyby na úrovni položek byla vždy nepravda. Počínaje verzí2020-06-30rozhraní API obsahuje každá chyba v seznamu nové vlastnosti"name","details"a"documentationLink".upozornění: Seznam upozornění na úrovni položek, pokud existuje. Příklad najdete v ukázkové odpovědi výše. Počínaje verzí
2020-06-30rozhraní API obsahuje každé upozornění v seznamu nové vlastnosti"name","details"a"documentationLink".itemsProcessed: Počet položek zdroje dat (například řádků tabulky), které se indexer pokusil indexovat během tohoto spuštění.
itemsFailed: Počet položek, které během tohoto spuštění selhaly. Chyba poskytuje ID položky, která selhala.
initialTrackingState: Vždy null pro první spuštění indexeru nebo pokud u použitého zdroje dat nejsou povolené zásady sledování změn dat. Pokud je taková zásada povolená, v následných spuštěních tato hodnota označuje první (nejnižší) hodnotu sledování změn zpracovanou tímto spuštěním.
finalTrackingState: Vždy null , pokud u použitého zdroje dat nejsou povolené zásady sledování změn dat. V opačném případě označuje nejnovější (nejvyšší) hodnotu sledování změn úspěšně zpracovanou tímto spuštěním.
Stav spuštění indexeru
Stav spuštění indexeru zachycuje stav spuštění jednoho indexeru. Může mít následující hodnoty:
success označuje, že provádění indexeru bylo úspěšně dokončeno.
inProgress označuje, že probíhá provádění indexeru.
transientFailure označuje, že spuštění indexeru selhalo. Podrobnosti najdete v tématu o vlastnosti errorMessage . Selhání může nebo nemusí vyžadovat zásah člověka, aby ho opravil. Například oprava nekompatibility schématu mezi zdrojem dat a cílovým indexem vyžaduje akci uživatele, zatímco dočasný výpadek zdroje dat ne. Vyvolání indexeru pokračuje podle plánu, pokud je definován. Pokud indexer podle plánu opakovaně dosáhne stavu transientFailure, aniž by provedl pokrok, začne indexer běžet v méně častém intervalu (maximálně jednou za 24 hodin), dokud nebude znovu úspěšně pokračovat.
persistentFailure označuje, že indexer selhal způsobem, který vyžaduje zásah člověka. Plánované spuštění indexeru se zastaví. Po vyřešení problému pomocí resetování indexeru (Rozhraní REST API Služby Azure AI Search) restartujte naplánovaná spuštění.
reset označuje, že indexer byl resetován voláním resetování indexeru (rozhraní REST API služby Azure AI Search).