Knowledge Sources - Get Status

Dienst:: Search Service

API-Version:: 2026-04-01

Ruft den Status einer Wissensquelle ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
sourceName	path	True	string	Der Name der Wissensquelle.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Accept		Accept	Die Überschrift "Annehmen".
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Antworten

Name	Typ	Beschreibung
200 OK	KnowledgeSourceStatus	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

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

Beispiele

SearchServiceGetKnowledgeSourceStatus

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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
  }
}

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
CompletedSynchronizationState	Stellt den abgeschlossenen Status der letzten Synchronisierung dar.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
KnowledgeSourceKind	Die Art der Wissensquelle.
KnowledgeSourceStatistics	Statistische Informationen über den Verlauf der Synchronisierung von Wissensquellen.
KnowledgeSourceStatus	Stellt den Status und den Synchronisierungsverlauf einer Wissensquelle dar.
KnowledgeSourceSynchronizationError	Repräsentiert einen Dokumenten-Indexierungsfehler, der während eines Wissensquellen-Synchronisationslaufs aufgetreten ist.
KnowledgeSourceSynchronizationStatus	Der aktuelle Synchronisierungsstatus der Wissensquelle.
SynchronizationState	Stellt den aktuellen Status einer laufenden Synchronisierung dar, die sich über mehrere Indexerausführungen erstreckt.

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=minimal

CompletedSynchronizationState

Objekt

Stellt den abgeschlossenen Status der letzten Synchronisierung dar.

Name	Typ	Beschreibung
endTime	string (date-time)	Die Endzeit der letzten abgeschlossenen Synchronisation.
itemsSkipped	integer (int32)	Die Anzahl der Elemente, die bei der letzten Synchronisierung übersprungen wurden.
itemsUpdatesFailed	integer (int32)	Die Anzahl der Elementaktualisierungen, die bei der letzten Synchronisierung fehlgeschlagen sind.
itemsUpdatesProcessed	integer (int32)	Die Anzahl der Elementaktualisierungen, die bei der letzten Synchronisierung erfolgreich verarbeitet wurden.
startTime	string (date-time)	Die Startzeit der letzten abgeschlossenen Synchronisation.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info		Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

KnowledgeSourceKind

Enumeration

Die Art der Wissensquelle.

Wert	Beschreibung
searchIndex	Eine Wissensquelle, die Daten aus einem Suchindex liest.
azureBlob	Eine Wissensquelle, die Daten aus Azure Blob Storage liest und in einem Suchindex erfasst.
indexedOneLake	Eine Wissensquelle, die Daten von indexierten OneLake ausliest.
web	Eine Wissensquelle, die Daten aus dem Web liest.

KnowledgeSourceStatistics

Objekt

Statistische Informationen über den Verlauf der Synchronisierung von Wissensquellen.

Name	Typ	Beschreibung
averageItemsProcessedPerSynchronization	integer (int32)	Durchschnittliche Artikel pro Synchronisation verarbeitet.
averageSynchronizationDuration	string	Durchschnittliche Synchronisationsdauer im HH:MM:SS-Format.
totalSynchronization	integer (int32)	Gesamtzahl der Synchronisationen.

KnowledgeSourceStatus

Objekt

Stellt den Status und den Synchronisierungsverlauf einer Wissensquelle dar.

Name	Typ	Beschreibung
currentSynchronizationState	SynchronizationState	Aktueller Synchronisierungsstatus, der sich über mehrere Indexerausführungen erstreckt.
kind	KnowledgeSourceKind	Identifiziert die Art der Wissensquelle direkt anhand der Statusantwort.
lastSynchronizationState	CompletedSynchronizationState	Details zur letzten abgeschlossenen Synchronisierung. Null bei der ersten Synchronisierung.
statistics	KnowledgeSourceStatistics	Statistische Informationen über den Verlauf der Synchronisierung von Wissensquellen. Null bei der ersten Synchronisierung.
synchronizationInterval	string	Das Synchronisationsintervall (z. B. '1d' für täglich). Null, wenn kein Zeitplan konfiguriert ist.
synchronizationStatus	KnowledgeSourceSynchronizationStatus	Der aktuelle Synchronisationsstatus.

KnowledgeSourceSynchronizationError

Objekt

Repräsentiert einen Dokumenten-Indexierungsfehler, der während eines Wissensquellen-Synchronisationslaufs aufgetreten ist.

Name	Typ	Beschreibung
details	string	Zusätzliche kontextuelle Informationen zum Ausfall.
docId	string	Die eindeutige Identifikatorin für das fehlgeschlagene Dokument oder Element innerhalb des Synchronisationslaufs.
documentationLink	string	Ein Link zu relevanter Fehlerbehebungsdokumentation.
errorMessage	string	Für Menschen lesbare, kundensichtbare Fehlermeldung.
name	string	Name der Eingabe- oder Verarbeitungskomponente, die den Fehler meldet.
statusCode	integer (int32)	HTTP-ähnlicher Statuscode, der die Fehlerkategorie darstellt (z. B. 400).

KnowledgeSourceSynchronizationStatus

Enumeration

Der aktuelle Synchronisierungsstatus der Wissensquelle.

Wert	Beschreibung
creating	Die Wissensquelle wird bereitgestellt.
active	Die Wissensquelle ist aktiv, und es finden Synchronisierungsläufe statt.
deleting	Die Wissensquelle wird gelöscht, und die Synchronisierung wird angehalten.

SynchronizationState

Objekt

Stellt den aktuellen Status einer laufenden Synchronisierung dar, die sich über mehrere Indexerausführungen erstreckt.

Name	Typ	Beschreibung
errors	KnowledgeSourceSynchronizationError[]	Sammlung von Dokumenten-Indexierungsfehlern, die während des aktuellen Synchronisationslaufs auftreten. Nur zurückgegeben, wenn Fehler vorhanden sind.
itemsSkipped	integer (int32)	Die Anzahl der Elemente, die in der aktuellen Synchronisierung übersprungen wurden.
itemsUpdatesFailed	integer (int32)	Die Anzahl der Elementaktualisierungen, die bei der aktuellen Synchronisierung fehlgeschlagen sind.
itemsUpdatesProcessed	integer (int32)	Die Anzahl der Elementaktualisierungen, die in der aktuellen Synchronisierung erfolgreich verarbeitet wurden.
startTime	string (date-time)	Die Startzeit der aktuellen Synchronisation.