Knowledge Sources - Get Status

Služba:: Search Service

Verze rozhraní API:: 2026-04-01

Získává status zdroje znalostí.

GET {endpoint}/knowledgesources('{sourceName}')/status?api-version=2026-04-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Adresa URL koncového bodu vyhledávací služby.
sourceName	path	True	string	Název zdroje znalostí.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Accept		Accept	Hlavička Accept.
x-ms-client-request-id		string (uuid)	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Odpovědi

Name	Typ	Description
200 OK	KnowledgeSourceStatus	Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

Name	Description
https://search.azure.com/.default

Příklady

SearchServiceGetKnowledgeSourceStatus

Ukázkový požadavek

HTTP

GET https://exampleservice.search.windows.net/knowledgesources('ks-example-index')/status?api-version=2026-04-01

Ukázková odpověď

Stavový kód:: 200

{
  "kind": "searchIndex",
  "synchronizationStatus": "active",
  "synchronizationInterval": "1d",
  "currentSynchronizationState": {
    "startTime": "2024-11-26T03:37:18.853Z",
    "itemsUpdatesProcessed": 10,
    "itemsUpdatesFailed": 2,
    "itemsSkipped": 1
  },
  "lastSynchronizationState": {
    "startTime": "2024-11-25T03:37:18.853Z",
    "endTime": "2024-11-25T03:38:19.012Z",
    "itemsUpdatesProcessed": 8,
    "itemsUpdatesFailed": 1,
    "itemsSkipped": 0
  },
  "statistics": {
    "totalSynchronization": 5,
    "averageSynchronizationDuration": "PT30M",
    "averageItemsProcessedPerSynchronization": 100
  }
}

Definice

Name	Description
Accept	Hlavička Accept.
CompletedSynchronizationState	Představuje dokončený stav poslední synchronizace.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
KnowledgeSourceKind	Druh zdroje znalostí.
KnowledgeSourceStatistics	Statistické informace o historii synchronizace zdrojů znalostí.
KnowledgeSourceStatus	Představuje stav a historii synchronizace zdroje znalostí.
KnowledgeSourceSynchronizationError	Představuje chybu indexování na úrovni dokumentu, ke které se vyskytla během synchronizace znalostního zdroje.
KnowledgeSourceSynchronizationStatus	Aktuální stav synchronizace zdroje znalostí.
SynchronizationState	Představuje aktuální stav probíhající synchronizace, která zahrnuje více spuštění indexeru.

Accept

Výčet

Hlavička Accept.

Hodnota	Description
application/json;odata.metadata=minimal

CompletedSynchronizationState

Objekt

Představuje dokončený stav poslední synchronizace.

Name	Typ	Description
endTime	string (date-time)	Čas ukončení poslední dokončené synchronizace.
itemsSkipped	integer (int32)	Počet položek přeskočených při poslední synchronizaci.
itemsUpdatesFailed	integer (int32)	Počet aktualizací položek, které se nezdařily při poslední synchronizaci.
itemsUpdatesProcessed	integer (int32)	Počet aktualizací položek úspěšně zpracovaných při poslední synchronizaci.
startTime	string (date-time)	Čas zahájení poslední dokončené synchronizace.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info		Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

KnowledgeSourceKind

Výčet

Druh zdroje znalostí.

Hodnota	Description
searchIndex	Zdroj znalostí, který čte data z indexu vyhledávání.
azureBlob	Zdroj znalostí, který čte a ingestuje data z Azure Blob Storage do indexu vyhledávání.
indexedOneLake	Zdroj znalostí, který čte data z indexovaného OneLake.
web	Zdroj znalostí, který čte data z webu.

KnowledgeSourceStatistics

Objekt

Statistické informace o historii synchronizace zdrojů znalostí.

Name	Typ	Description
averageItemsProcessedPerSynchronization	integer (int32)	Průměrné položky zpracované na jednu synchronizaci.
averageSynchronizationDuration	string	Průměrná doba synchronizace ve formátu HH:MM:SS.
totalSynchronization	integer (int32)	Celkový počet synchronizací.

KnowledgeSourceStatus

Objekt

Představuje stav a historii synchronizace zdroje znalostí.

Name	Typ	Description
currentSynchronizationState	SynchronizationState	Aktuální stav synchronizace, který zahrnuje více spuštění indexeru.
kind	KnowledgeSourceKind	Identifikuje druh zdroje znalostí přímo z odpovědi Stav.
lastSynchronizationState	CompletedSynchronizationState	Podrobnosti o poslední dokončené synchronizaci. Hodnota null při první synchronizaci.
statistics	KnowledgeSourceStatistics	Statistické informace o historii synchronizace zdrojů znalostí. Hodnota null při první synchronizaci.
synchronizationInterval	string	Interval synchronizace (např. "1d" pro denní). Hodnota null, pokud není nakonfigurován žádný plán.
synchronizationStatus	KnowledgeSourceSynchronizationStatus	Aktuální stav synchronizace.

KnowledgeSourceSynchronizationError

Objekt

Představuje chybu indexování na úrovni dokumentu, ke které se vyskytla během synchronizace znalostního zdroje.

Name	Typ	Description
details	string	Další kontextové informace o selhání.
docId	string	Jedinečný identifikátor neúspěšného dokumentu nebo položky v synchronizačním běhu.
documentationLink	string	Odkaz na relevantní dokumentaci k řešení problémů.
errorMessage	string	Chybová zpráva čitelná pro člověka, viditelná pro zákazníka.
name	string	Název komponenty pro příjem nebo zpracování, která hlásí chybu.
statusCode	integer (int32)	HTTP-podobný stavový kód reprezentující kategorii selhání (např. 400).

KnowledgeSourceSynchronizationStatus

Výčet

Aktuální stav synchronizace zdroje znalostí.

Hodnota	Description
creating	Zdroj znalostí se poskytuje.
active	Zdroj znalostí je aktivní a dochází k synchronizačním běhům.
deleting	Zdroj znalostí se maže a synchronizace se pozastaví.

SynchronizationState

Objekt

Představuje aktuální stav probíhající synchronizace, která zahrnuje více spuštění indexeru.

Name	Typ	Description
errors	KnowledgeSourceSynchronizationError[]	Sbírka chyb indexování na úrovni dokumentu, které byly zjištěny během aktuálního synchronizačního běhu. Vráceno pouze tehdy, když jsou přítomny chyby.
itemsSkipped	integer (int32)	Počet položek přeskočených v aktuální synchronizaci.
itemsUpdatesFailed	integer (int32)	Počet aktualizací položek, které se v aktuální synchronizaci nezdařily.
itemsUpdatesProcessed	integer (int32)	Počet aktualizací položek úspěšně zpracovaných v aktuální synchronizaci.
startTime	string (date-time)	Čas zahájení aktuální synchronizace.