Knowledge Sources - Get Status

Dienst:: Search Service

API-Version:: 2025-11-01-preview

Ruft den Status einer Wissensquelle ab.

GET https:///knowledgesources('{sourceName}')/status?api-version=2025-11-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
sourceName	path	True	string	Der Name der Wissensquelle.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Accept	True	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:///knowledgesources('ks-preview-test')/status?api-version=2025-11-01-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "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	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
KnowledgeSourceStatistics	Statistische Informationen über den Verlauf der Synchronisierung von Wissensquellen.
KnowledgeSourceStatus	Stellt den Status und den Synchronisierungsverlauf einer Wissensquelle dar.
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

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

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.
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.

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
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.

Freigeben über

Knowledge Sources - Get Status

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

api-key

OAuth2Auth

Bereiche

Beispiele

SearchServiceGetKnowledgeSourceStatus

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Accept

CompletedSynchronizationState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KnowledgeSourceStatistics

KnowledgeSourceStatus

KnowledgeSourceSynchronizationStatus

SynchronizationState