Knowledge Sources - Get Status
Récupère le statut d’une source de connaissances.
GET https:///knowledgesources('{sourceName}')/status?api-version=2025-11-01-previewParamètres d’URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
source
|
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 | True |
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 |
La demande a réussi. |
|
| Other Status Codes |
Réponse d’erreur inattendue. |
Sécurité
api-key
Type:
apiKey
Dans:
header
OAuth2Auth
Type:
oauth2
Couler:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Étendues
| Nom | Description |
|---|---|
| https://search.azure.com/.default |
Exemples
SearchServiceGetKnowledgeSourceStatus
Demande d’échantillon
GET https:///knowledgesources('ks-preview-test')/status?api-version=2025-11-01-preview
Exemple de réponse
{
"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. |
|
Completed |
Représente l’état terminé de la dernière synchronisation. |
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
|
Error |
Détail de l’erreur. |
|
Error |
Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.). |
|
Knowledge |
Informations statistiques sur l’historique de synchronisation des sources de connaissances. |
|
Knowledge |
Représente l’état et l’historique de synchronisation d’une source de connaissances. |
|
Knowledge |
État actuel de la synchronisation de la source de connaissances. |
|
Synchronization |
Représente l’état actuel d’une synchronisation en cours qui s’étend sur plusieurs exécutions d’indexeur. |
Accept
L’en-tête Accept.
| Valeur | Description |
|---|---|
| application/json;odata.metadata=minimal |
CompletedSynchronizationState
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
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
Détail de l’erreur.
| Nom | Type | Description |
|---|---|---|
| additionalInfo |
Informations supplémentaires sur l’erreur. |
|
| code |
string |
Code d'erreur. |
| details |
Détails de l’erreur. |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
KnowledgeSourceStatistics
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
Représente l’état et l’historique de synchronisation d’une source de connaissances.
| Nom | Type | Description |
|---|---|---|
| currentSynchronizationState |
État de synchronisation actuel qui s’étend sur plusieurs exécutions de l’indexeur. |
|
| lastSynchronizationState |
Détails de la dernière synchronisation terminée. Vide lors de la première synchronisation. |
|
| statistics |
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 |
L’état actuel de la synchronisation. |
KnowledgeSourceSynchronizationStatus
É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
Représente l’état actuel d’une synchronisation en cours qui s’étend sur plusieurs exécutions d’indexeur.
| Nom | Type | Description |
|---|---|---|
| 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. |