Knowledge Sources - Get Status

Service:: Search Service

API-versie:: 2026-04-01

Haalt de status van een kennisbron op.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	De eindpunt-URL van de zoekservice.
sourceName	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		Accept	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	KnowledgeSourceStatus	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	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

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
Accept	De Accepteer kop.
CompletedSynchronizationState	Vertegenwoordigt de voltooide status van de laatste synchronisatie.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
KnowledgeSourceKind	Het soort kennisbron.
KnowledgeSourceStatistics	Statistische informatie over de synchronisatiegeschiedenis van kennisbronnen.
KnowledgeSourceStatus	Vertegenwoordigt de status en synchronisatiegeschiedenis van een kennisbron.
KnowledgeSourceSynchronizationError	Vertegenwoordigt een indexeringsfout op documentniveau die wordt aangetroffen tijdens een kennisbron-synchronisatierun.
KnowledgeSourceSynchronizationStatus	De huidige synchronisatiestatus van de kennisbron.
SynchronizationState	Vertegenwoordigt de huidige status van een doorlopende synchronisatie die meerdere indexeeruitvoeringen omvat.

Accept

Opsomming

De Accepteer kop.

Waarde	Description
application/json;odata.metadata=minimal

CompletedSynchronizationState

Object

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

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info		De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoelwit.

ErrorResponse

Object

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name	Type	Description
error	ErrorDetail	Het foutobject.

KnowledgeSourceKind

Opsomming

Het soort kennisbron.

Waarde	Description
searchIndex	Een kennisbron die gegevens uit een zoekindex leest.
azureBlob	Een kennisbron die gegevens van Azure Blob Storage leest en opneemt in een zoekindex.
indexedOneLake	Een kennisbron die gegevens leest van geïndexeerde OneLake.
web	Een kennisbron die data van het web leest.

KnowledgeSourceStatistics

Object

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

Object

Vertegenwoordigt de status en synchronisatiegeschiedenis van een kennisbron.

Name	Type	Description
currentSynchronizationState	SynchronizationState	Huidige synchronisatiestatus die meerdere indexeerfuncties omvat.
kind	KnowledgeSourceKind	Identificeert het type Knowledge Source direct vanuit de Status-respons.
lastSynchronizationState	CompletedSynchronizationState	Details van de laatst voltooide synchronisatie. Null bij eerste synchronisatie.
statistics	KnowledgeSourceStatistics	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	KnowledgeSourceSynchronizationStatus	De huidige synchronisatiestatus.

KnowledgeSourceSynchronizationError

Object

Vertegenwoordigt een indexeringsfout op documentniveau die wordt aangetroffen tijdens een kennisbron-synchronisatierun.

Name	Type	Description
details	string	Aanvullende contextuele informatie over de mislukking.
docId	string	De unieke identificatie voor het mislukte document of item binnen de synchronisatierun.
documentationLink	string	Een link naar relevante probleemoplossingsdocumentatie.
errorMessage	string	Voor mensen leesbaar, klantzichtbaar foutmelding.
name	string	Naam van de ingestie- of verwerkingscomponent die de fout rapporteert.
statusCode	integer (int32)	HTTP-achtige statuscode die de faalcategorie vertegenwoordigt (bijv. 400).

KnowledgeSourceSynchronizationStatus

Opsomming

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

Object

Vertegenwoordigt de huidige status van een doorlopende synchronisatie die meerdere indexeeruitvoeringen omvat.

Name	Type	Description
errors	KnowledgeSourceSynchronizationError[]	Verzameling van indexeringsfouten op documentniveau die zijn tegengekomen tijdens de huidige synchronisatierun. Alleen teruggegeven wanneer er fouten aanwezig zijn.
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.