Knowledge Sources - Get Status

Tjänst:: Search Service

API-version:: 2026-04-01

Hämtar statusen för en kunskapskälla.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Slutpunkts-URL:en för söktjänsten.
sourceName	path	True	string	Namnet på kunskapskällan.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Accept		Accept	Acceptera-rubriken.
x-ms-client-request-id		string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Svar

Name	Typ	Description
200 OK	KnowledgeSourceStatus	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

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

Exempel

SearchServiceGetKnowledgeSourceStatus

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Accept	Acceptera-rubriken.
CompletedSynchronizationState	Representerar det slutförda tillståndet för den senaste synkroniseringen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
KnowledgeSourceKind	Typen av kunskapskälla.
KnowledgeSourceStatistics	Statistisk information om synkroniseringshistorik för kunskapskälla.
KnowledgeSourceStatus	Representerar status och synkroniseringshistorik för en kunskapskälla.
KnowledgeSourceSynchronizationError	Representerar ett indexeringsfel på dokumentnivå som uppstår under en körning av kunskapskällssynkronisering.
KnowledgeSourceSynchronizationStatus	Den aktuella synkroniseringsstatusen för kunskapskällan.
SynchronizationState	Representerar det aktuella tillståndet för en pågående synkronisering som sträcker sig över flera indexerarkörningar.

Accept

Uppräkning

Acceptera-rubriken.

Värde	Description
application/json;odata.metadata=minimal

CompletedSynchronizationState

Objekt

Representerar det slutförda tillståndet för den senaste synkroniseringen.

Name	Typ	Description
endTime	string (date-time)	Sluttiden för den senast slutförda synkroniseringen.
itemsSkipped	integer (int32)	Antalet objekt som hoppades över i den senaste synkroniseringen.
itemsUpdatesFailed	integer (int32)	Antalet objektuppdateringar som misslyckades vid den senaste synkroniseringen.
itemsUpdatesProcessed	integer (int32)	Antalet objektuppdateringar som har bearbetats under den senaste synkroniseringen.
startTime	string (date-time)	Starttiden för den senast slutförda synkroniseringen.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info		Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error	ErrorDetail	Felet objektet.

KnowledgeSourceKind

Uppräkning

Typen av kunskapskälla.

Värde	Description
searchIndex	En kunskapskälla som läser data från ett sökindex.
azureBlob	En kunskapskälla som läser och matar in data från Azure Blob Storage till ett sökindex.
indexedOneLake	En kunskapskälla som läser data från indexerad OneLake.
web	En kunskapskälla som läser data från webben.

KnowledgeSourceStatistics

Objekt

Statistisk information om synkroniseringshistorik för kunskapskälla.

Name	Typ	Description
averageItemsProcessedPerSynchronization	integer (int32)	Genomsnittligt antal bearbetade artiklar per synkronisering.
averageSynchronizationDuration	string	Genomsnittlig synkroniseringstid i HH:MM:SS-format.
totalSynchronization	integer (int32)	Totalt antal synkroniseringar.

KnowledgeSourceStatus

Objekt

Representerar status och synkroniseringshistorik för en kunskapskälla.

Name	Typ	Description
currentSynchronizationState	SynchronizationState	Aktuellt synkroniseringstillstånd som sträcker sig över flera indexerarkörningar.
kind	KnowledgeSourceKind	Identifierar Knowledge Source-typen direkt från statussvaret.
lastSynchronizationState	CompletedSynchronizationState	Information om den senast slutförda synkroniseringen. Null vid första synkroniseringen.
statistics	KnowledgeSourceStatistics	Statistisk information om synkroniseringshistoriken för kunskapskällan. Null vid första synkroniseringen.
synchronizationInterval	string	Synkroniseringsintervallet (t.ex. "1d" för dagligen). Null om inget schema har konfigurerats.
synchronizationStatus	KnowledgeSourceSynchronizationStatus	Den aktuella synkroniseringsstatusen.

KnowledgeSourceSynchronizationError

Objekt

Representerar ett indexeringsfel på dokumentnivå som uppstår under en körning av kunskapskällssynkronisering.

Name	Typ	Description
details	string	Ytterligare kontextuell information om felet.
docId	string	Den unika identifieraren för det misslyckade dokumentet eller objektet inom synkroniseringskörningen.
documentationLink	string	En länk till relevant felsökningsdokumentation.
errorMessage	string	Mänskligt läsbart, kundsynligt felmeddelande.
name	string	Namnet på den insamlings- eller bearbetningskomponent som rapporterar felet.
statusCode	integer (int32)	HTTP-liknande statuskod som representerar felkategorin (t.ex. 400).

KnowledgeSourceSynchronizationStatus

Uppräkning

Den aktuella synkroniseringsstatusen för kunskapskällan.

Värde	Description
creating	Kunskapskällan etableras.
active	Kunskapskällan är aktiv och synkroniseringskörningar sker.
deleting	Kunskapskällan tas bort och synkroniseringen pausas.

SynchronizationState

Objekt

Representerar det aktuella tillståndet för en pågående synkronisering som sträcker sig över flera indexerarkörningar.

Name	Typ	Description
errors	KnowledgeSourceSynchronizationError[]	Samling av indexeringsfel på dokumentnivå som uppstod under den aktuella synkroniseringskörningen. Returneras endast när fel finns.
itemsSkipped	integer (int32)	Antalet objekt som hoppats över i den aktuella synkroniseringen.
itemsUpdatesFailed	integer (int32)	Antalet artikeluppdateringar som misslyckades i den aktuella synkroniseringen.
itemsUpdatesProcessed	integer (int32)	Antalet artikeluppdateringar som har bearbetats i den aktuella synkroniseringen.
startTime	string (date-time)	Starttiden för den aktuella synkroniseringen.