Knowledge Sources - Get Status

Service:: Search Service

Version d'API:: 2026-04-01

Récupère le statut d’une source de connaissances.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL du point de terminaison du service de recherche.
sourceName	path	True	string	Nom de la source de connaissances.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
Accept		Accept	L’en-tête Accept.
x-ms-client-request-id		string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Réponses

Nom	Type	Description
200 OK	KnowledgeSourceStatus	La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

api-key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

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

Exemples

SearchServiceGetKnowledgeSourceStatus

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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
  }
}

Définitions

Nom	Description
Accept	L’en-tête Accept.
CompletedSynchronizationState	Représente l’état terminé de la dernière synchronisation.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).
KnowledgeSourceKind	Le type de source de connaissance.
KnowledgeSourceStatistics	Informations statistiques sur l’historique de synchronisation des sources de connaissances.
KnowledgeSourceStatus	Représente l’état et l’historique de synchronisation d’une source de connaissances.
KnowledgeSourceSynchronizationError	Représente une erreur d’indexation au niveau du document rencontrée lors d’une exécution de synchronisation de source de connaissances.
KnowledgeSourceSynchronizationStatus	État actuel de la synchronisation de la source de connaissances.
SynchronizationState	Représente l’état actuel d’une synchronisation en cours qui s’étend sur plusieurs exécutions d’indexeur.

Accept

Énumération

L’en-tête Accept.

Valeur	Description
application/json;odata.metadata=minimal

CompletedSynchronizationState

Objet

Représente l’état terminé de la dernière synchronisation.

Nom	Type	Description
endTime	string (date-time)	Heure de fin de la dernière synchronisation terminée.
itemsSkipped	integer (int32)	Nombre d’éléments ignorés lors de la dernière synchronisation.
itemsUpdatesFailed	integer (int32)	Nombre de mises à jour d’éléments qui ont échoué lors de la dernière synchronisation.
itemsUpdatesProcessed	integer (int32)	Nombre de mises à jour d’éléments traitées avec succès lors de la dernière synchronisation.
startTime	string (date-time)	Heure de début de la dernière synchronisation terminée.

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info		Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

KnowledgeSourceKind

Énumération

Le type de source de connaissance.

Valeur	Description
searchIndex	Source de connaissances qui lit les données d’un index de recherche.
azureBlob	Source de connaissances qui lit et ingère des données de Stockage Blob Azure dans un index de recherche.
indexedOneLake	Une source de connaissances qui lit les données provenant de OneLake indexé.
web	Une source de connaissances qui lit des données du web.

KnowledgeSourceStatistics

Objet

Informations statistiques sur l’historique de synchronisation des sources de connaissances.

Nom	Type	Description
averageItemsProcessedPerSynchronization	integer (int32)	Éléments moyens traités par synchronisation.
averageSynchronizationDuration	string	Durée moyenne de synchronisation au format HH :MM :SS.
totalSynchronization	integer (int32)	Nombre total de synchronisations.

KnowledgeSourceStatus

Objet

Représente l’état et l’historique de synchronisation d’une source de connaissances.

Nom	Type	Description
currentSynchronizationState	SynchronizationState	État de synchronisation actuel qui s’étend sur plusieurs exécutions de l’indexeur.
kind	KnowledgeSourceKind	Identifie le type Source de Connaissances directement à partir de la réponse Status.
lastSynchronizationState	CompletedSynchronizationState	Détails de la dernière synchronisation terminée. Vide lors de la première synchronisation.
statistics	KnowledgeSourceStatistics	Informations statistiques sur l’historique de synchronisation de la source de connaissances. Vide lors de la première synchronisation.
synchronizationInterval	string	L’intervalle de synchronisation (par exemple, « 1d » pour quotidien). Vide si aucune planification n’est configurée.
synchronizationStatus	KnowledgeSourceSynchronizationStatus	L’état actuel de la synchronisation.

KnowledgeSourceSynchronizationError

Objet

Représente une erreur d’indexation au niveau du document rencontrée lors d’une exécution de synchronisation de source de connaissances.

Nom	Type	Description
details	string	Informations contextuelles supplémentaires sur la défaillance.
docId	string	L’identifiant unique du document ou de l’élément défaillant lors de l’exécution de synchronisation.
documentationLink	string	Un lien vers la documentation pertinente pour le dépannage.
errorMessage	string	Message d’erreur lisible par l’humain, visible pour le client.
name	string	Nom du composant d’ingestion ou de traitement signalant l’erreur.
statusCode	integer (int32)	Code d’état de type HTTP représentant la catégorie de défaillance (par exemple, 400).

KnowledgeSourceSynchronizationStatus

Énumération

État actuel de la synchronisation de la source de connaissances.

Valeur	Description
creating	La source de connaissances est en cours d’approvisionnement.
active	La source de connaissances est active et des exécutions de synchronisation sont en cours.
deleting	La source de connaissances est supprimée et la synchronisation est suspendue.

SynchronizationState

Objet

Représente l’état actuel d’une synchronisation en cours qui s’étend sur plusieurs exécutions d’indexeur.

Nom	Type	Description
errors	KnowledgeSourceSynchronizationError[]	Collection d’erreurs d’indexation au niveau du document rencontrées lors de l’exécution de synchronisation en cours. Retourné uniquement lorsque des erreurs sont présentes.
itemsSkipped	integer (int32)	Nombre d’éléments ignorés dans la synchronisation en cours.
itemsUpdatesFailed	integer (int32)	Nombre de mises à jour d’éléments qui ont échoué lors de la synchronisation en cours.
itemsUpdatesProcessed	integer (int32)	Nombre de mises à jour d’éléments traitées avec succès dans la synchronisation en cours.
startTime	string (date-time)	Heure de début de la synchronisation en cours.