Knowledge Sources - Get Status

Servizio:

Search Service

Versione API:

2025-11-01-preview

Recupera lo stato di una fonte di conoscenza.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
sourceName	path	True	string	Il nome dell'origine della conoscenza.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Accept	True	Accept	L'intestazione Accetta.
x-ms-client-request-id		string (uuid)	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	KnowledgeSourceStatus	La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

api-key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome	Descrizione
https://search.azure.com/.default

Esempio

SearchServiceGetKnowledgeSourceStatus

Esempio di richiesta

HTTP

GET https:///knowledgesources('ks-preview-test')/status?api-version=2025-11-01-preview

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
Accept	L'intestazione Accetta.
CompletedSynchronizationState	Rappresenta lo stato completato dell'ultima sincronizzazione.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.
KnowledgeSourceStatistics	Informazioni statistiche sulla cronologia di sincronizzazione dell'origine della conoscenza.
KnowledgeSourceStatus	Rappresenta lo stato e la cronologia di sincronizzazione di un'origine della conoscenza.
KnowledgeSourceSynchronizationStatus	Stato di sincronizzazione corrente dell'origine della conoscenza.
SynchronizationState	Rappresenta lo stato corrente di una sincronizzazione in corso che si estende su più esecuzioni dell'indicizzatore.

Accept

Enumerazione

L'intestazione Accetta.

Valore	Descrizione
application/json;odata.metadata=minimal

CompletedSynchronizationState

Oggetto

Rappresenta lo stato completato dell'ultima sincronizzazione.

Nome	Tipo	Descrizione
endTime	string (date-time)	Ora di fine dell'ultima sincronizzazione completata.
itemsSkipped	integer (int32)	Il numero di elementi ignorati nell'ultima sincronizzazione.
itemsUpdatesFailed	integer (int32)	Numero di aggiornamenti degli elementi non riusciti nell'ultima sincronizzazione.
itemsUpdatesProcessed	integer (int32)	Numero di aggiornamenti degli elementi elaborati correttamente nell'ultima sincronizzazione.
startTime	string (date-time)	Ora di inizio dell'ultima sincronizzazione completata.

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info		Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

KnowledgeSourceStatistics

Oggetto

Informazioni statistiche sulla cronologia di sincronizzazione dell'origine della conoscenza.

Nome	Tipo	Descrizione
averageItemsProcessedPerSynchronization	integer (int32)	Elementi media processati per sincronizzazione.
averageSynchronizationDuration	string	Durata media di sincronizzazione in formato HH:MM:SS.
totalSynchronization	integer (int32)	Numero totale di sincronizzazioni.

KnowledgeSourceStatus

Oggetto

Rappresenta lo stato e la cronologia di sincronizzazione di un'origine della conoscenza.

Nome	Tipo	Descrizione
currentSynchronizationState	SynchronizationState	Stato di sincronizzazione corrente che si estende su più esecuzioni dell'indicizzatore.
lastSynchronizationState	CompletedSynchronizationState	Dettagli dell'ultima sincronizzazione completata. Null alla prima sincronizzazione.
statistics	KnowledgeSourceStatistics	Informazioni statistiche sulla cronologia di sincronizzazione dell'origine della conoscenza. Null alla prima sincronizzazione.
synchronizationInterval	string	L'intervallo di sincronizzazione (ad esempio, '1g' per giornaliero). Null se non è configurata alcuna pianificazione.
synchronizationStatus	KnowledgeSourceSynchronizationStatus	Lo stato attuale della sincronizzazione.

KnowledgeSourceSynchronizationStatus

Enumerazione

Stato di sincronizzazione corrente dell'origine della conoscenza.

Valore	Descrizione
creating	È in corso il provisioning dell'origine della conoscenza.
active	L'origine informazioni è attiva ed è in corso l'esecuzione della sincronizzazione.
deleting	L'origine della conoscenza viene eliminata e la sincronizzazione viene sospesa.

SynchronizationState

Oggetto

Rappresenta lo stato corrente di una sincronizzazione in corso che si estende su più esecuzioni dell'indicizzatore.

Nome	Tipo	Descrizione
itemsSkipped	integer (int32)	Il numero di elementi ignorati nella sincronizzazione corrente.
itemsUpdatesFailed	integer (int32)	Numero di aggiornamenti degli elementi non riusciti nella sincronizzazione corrente.
itemsUpdatesProcessed	integer (int32)	Numero di aggiornamenti degli elementi elaborati correttamente nella sincronizzazione corrente.
startTime	string (date-time)	Ora di inizio della sincronizzazione corrente.