Knowledge Sources - Get Status
Haalt de status van een kennisbron op.
GET https:///knowledgesources('{sourceName}')/status?api-version=2025-11-01-previewURI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
source
|
path | True |
string |
De naam van de kennisbron. |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| Accept | True |
De Accepteer kop. |
|
| x-ms-client-request-id |
string (uuid) |
Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
De aanvraag is voltooid. |
|
| Other Status Codes |
Een onverwachte foutreactie. |
Beveiliging
api-key
Type:
apiKey
In:
header
OAuth2Auth
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Bereiken
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Voorbeelden
SearchServiceGetKnowledgeSourceStatus
Voorbeeldaanvraag
GET https:///knowledgesources('ks-preview-test')/status?api-version=2025-11-01-preview
Voorbeeldrespons
{
"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
}
}Definities
| Name | Description |
|---|---|
| Accept |
De Accepteer kop. |
|
Completed |
Vertegenwoordigt de voltooide status van de laatste synchronisatie. |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
|
Error |
De foutdetails. |
|
Error |
Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.) |
|
Knowledge |
Statistische informatie over de synchronisatiegeschiedenis van kennisbronnen. |
|
Knowledge |
Vertegenwoordigt de status en synchronisatiegeschiedenis van een kennisbron. |
|
Knowledge |
De huidige synchronisatiestatus van de kennisbron. |
|
Synchronization |
Vertegenwoordigt de huidige status van een doorlopende synchronisatie die meerdere indexeeruitvoeringen omvat. |
Accept
De Accepteer kop.
| Waarde | Description |
|---|---|
| application/json;odata.metadata=minimal |
CompletedSynchronizationState
Vertegenwoordigt de voltooide status van de laatste synchronisatie.
| Name | Type | Description |
|---|---|---|
| endTime |
string (date-time) |
De eindtijd van de laatst voltooide synchronisatie. |
| itemsSkipped |
integer (int32) |
Het aantal items dat is overgeslagen in de laatste synchronisatie. |
| itemsUpdatesFailed |
integer (int32) |
Het aantal itemupdates dat is mislukt tijdens de laatste synchronisatie. |
| itemsUpdatesProcessed |
integer (int32) |
Het aantal itemupdates dat is verwerkt in de laatste synchronisatie. |
| startTime |
string (date-time) |
De begintijd van de laatst voltooide synchronisatie. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name | Type | Description |
|---|---|---|
| info |
De aanvullende informatie. |
|
| type |
string |
Het extra informatietype. |
ErrorDetail
De foutdetails.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
De fout bevat aanvullende informatie. |
|
| code |
string |
De foutcode. |
| details |
De foutdetails. |
|
| message |
string |
Het foutbericht. |
| target |
string |
Het foutdoel. |
ErrorResponse
Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
KnowledgeSourceStatistics
Statistische informatie over de synchronisatiegeschiedenis van kennisbronnen.
| Name | Type | Description |
|---|---|---|
| averageItemsProcessedPerSynchronization |
integer (int32) |
Gemiddeld verwerkt items per synchronisatie. |
| averageSynchronizationDuration |
string |
Gemiddelde synchronisatieduur in HH:MM:SS-formaat. |
| totalSynchronization |
integer (int32) |
Totaal aantal synchronisaties. |
KnowledgeSourceStatus
Vertegenwoordigt de status en synchronisatiegeschiedenis van een kennisbron.
| Name | Type | Description |
|---|---|---|
| currentSynchronizationState |
Huidige synchronisatiestatus die meerdere indexeerfuncties omvat. |
|
| lastSynchronizationState |
Details van de laatst voltooide synchronisatie. Null bij eerste synchronisatie. |
|
| statistics |
Statistische informatie over de synchronisatiegeschiedenis van de kennisbron. Null bij eerste synchronisatie. |
|
| synchronizationInterval |
string |
Het synchronisatie-interval (bijv. '1d' voor dagelijks). Null als er geen planning is geconfigureerd. |
| synchronizationStatus |
De huidige synchronisatiestatus. |
KnowledgeSourceSynchronizationStatus
De huidige synchronisatiestatus van de kennisbron.
| Waarde | Description |
|---|---|
| creating |
De kennisbron wordt ter beschikking gesteld. |
| active |
De kennisbron is actief en er vinden synchronisatie-uitvoeringen plaats. |
| deleting |
De kennisbron wordt verwijderd en de synchronisatie wordt onderbroken. |
SynchronizationState
Vertegenwoordigt de huidige status van een doorlopende synchronisatie die meerdere indexeeruitvoeringen omvat.
| Name | Type | Description |
|---|---|---|
| itemsSkipped |
integer (int32) |
Het aantal items dat is overgeslagen in de huidige synchronisatie. |
| itemsUpdatesFailed |
integer (int32) |
Het aantal item-updates dat is mislukt in de huidige synchronisatie. |
| itemsUpdatesProcessed |
integer (int32) |
Het aantal artikelupdates dat met succes is verwerkt in de huidige synchronisatie. |
| startTime |
string (date-time) |
De starttijd van de huidige synchronisatie. |