Knowledge Sources - Get Status
Visszanyeri a tudásforrás státuszát.
GET {endpoint}/knowledgesources('{sourceName}')/status?api-version=2026-08-01-preview
URI-paraméterek
| Név | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
A keresési szolgáltatás végpontjának URL-címe. |
|
source
|
path | True |
string |
A tudásforrás neve. |
|
api-version
|
query | True |
string minLength: 1 |
A művelethez használni kívánt API-verzió. |
Kérelem fejléce
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója. |
|
| Accept |
Az Elfogadás fejléce. |
Válaszok
| Név | Típus | Description |
|---|---|---|
| 200 OK |
A kérés sikeres volt. |
|
| Other Status Codes |
Váratlan hibaválasz. |
Biztonság
api-key
Típus:
apiKey
In:
header
OAuth2Auth
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Hatókörök
| Név | Description |
|---|---|
| https://search.azure.com/.default |
Példák
SearchServiceGetKnowledgeSourceStatus
Mintakérelem
GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')/status?api-version=2026-08-01-preview
Mintaválasz
{
"kind": "azureBlob",
"synchronizationStatus": "active",
"synchronizationInterval": "1d",
"currentSynchronizationState": {
"startTime": "2024-11-26T03:37:18.853Z",
"itemsUpdatesProcessed": 10,
"itemsUpdatesFailed": 2,
"itemsSkipped": 1,
"errors": []
},
"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
}
}
Definíciók
| Név | Description |
|---|---|
| Accept |
Az Elfogadás fejléce. |
|
Completed |
Az utolsó szinkronizálás befejezett állapotát jelöli. |
|
Error |
Az erőforrás-kezelési hiba további információi. |
|
Error |
A hiba részletei. |
|
Error |
Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.) |
|
Knowledge |
A tudásforrás fajtája. |
|
Knowledge |
Statisztikai adatok a tudásforrás-szinkronizálási előzményekről. |
|
Knowledge |
Egy tudásforrás állapotát és szinkronizálási előzményeit jelöli. |
|
Knowledge |
Egy dokumentumszintű indexelési hibát képvisel, amely egy tudásforrás szinkronizációs futtatás során fordul elő. |
|
Knowledge |
A tudásforrás aktuális szinkronizálási állapota. |
|
Synchronization |
Egy folyamatban lévő szinkronizálás aktuális állapotát jelöli, amely több indexelő futtatására terjed ki. |
Accept
Az Elfogadás fejléce.
| Érték | Description |
|---|---|
| application/json;odata.metadata=minimal |
CompletedSynchronizationState
Az utolsó szinkronizálás befejezett állapotát jelöli.
| Név | Típus | Description |
|---|---|---|
| endTime |
string (date-time) |
Az utolsó befejezett szinkronizálás befejezési ideje. |
| itemsSkipped |
integer (int32) |
Az utolsó szinkronizálás során kihagyott elemek száma. |
| itemsUpdatesFailed |
integer (int32) |
Az utolsó szinkronizálás során meghiúsult elemfrissítések száma. |
| itemsUpdatesProcessed |
integer (int32) |
Az utolsó szinkronizálás során sikeresen feldolgozott elemfrissítések száma. |
| startTime |
string (date-time) |
Az utolsó befejezett szinkronizálás kezdési időpontja. |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
| Név | Típus | Description |
|---|---|---|
| info |
A további információk. |
|
| type |
string |
A további információtípus. |
ErrorDetail
A hiba részletei.
| Név | Típus | Description |
|---|---|---|
| additionalInfo |
A hiba további információi. |
|
| code |
string |
A hibakód. |
| details |
A hiba részletei. |
|
| message |
string |
A hibaüzenet. |
| target |
string |
A hiba célpontja. |
ErrorResponse
Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
| Név | Típus | Description |
|---|---|---|
| error |
A hibaobjektum. |
KnowledgeSourceKind
A tudásforrás fajtája.
| Érték | Description |
|---|---|
| searchIndex |
Olyan tudásforrás, amely adatokat olvas be egy keresési indexből. |
| azureBlob |
Olyan tudásforrás, amely adatokat olvas és tölt be az Azure Blob Storage-ból egy keresési indexbe. |
| indexedSharePoint |
Egy tudásforrás, amely adatokat olvas az indexelt SharePoint-ről. |
| indexedOneLake |
Egy tudásforrás, amely adatokat olvas az indexelt OneLake-ből. |
| indexedSql |
Egy tudásforrás, amely adatokat keres és fogad be Azure SQL Database-ből vagy SQL Managed Instance-ból egy Search Indexbe. |
| web |
Egy tudásforrás, amely adatokat olvas a webről. |
| remoteSharePoint |
Egy tudásforrás, amely adatokat olvas a távoli SharePoint-ról. |
| workIQ |
Egy tudásforrás, amely a munkahelyi IQ-ból olvas adatokat. |
| file |
Egy tudásforrás, amely támogatja a közvetlen fájlfeltöltést és indexelést. |
| mcpServer |
Egy MCP (Model Context Protocol) szerver által támogatott tudásforrás. |
| fabricDataAgent |
Egy tudásforrás, amely adatokat gyűjt egy Fabric Data Agent-ből. |
| fabricOntology |
Egy tudásforrás, amely adatokat keres a Microsoft Fabric Ontology ontológiaiból. |
KnowledgeSourceStatistics
Statisztikai adatok a tudásforrás-szinkronizálási előzményekről.
| Név | Típus | Description |
|---|---|---|
| averageItemsProcessedPerSynchronization |
integer (int32) |
Az átlagos feldolgozás a szinkronizálás során. |
| averageSynchronizationDuration |
string |
Átlagos szinkronizációs időtartam HH:MM:SS formátumban. |
| totalSynchronization |
integer (int32) |
A szinkronizációk összesített száma. |
KnowledgeSourceStatus
Egy tudásforrás állapotát és szinkronizálási előzményeit jelöli.
| Név | Típus | Description |
|---|---|---|
| currentSynchronizationState |
Több indexelőfuttatásra kiterjedő aktuális szinkronizálási állapot. |
|
| kind |
Közvetlenül azonosítja a Tudásforrás típust a Status válaszból. |
|
| lastSynchronizationState |
Az utolsó befejezett szinkronizálás részletei. Null az első szinkronizáláskor. |
|
| statistics |
Statisztikai adatok a tudásforrás szinkronizálási előzményeiről. Null az első szinkronizáláskor. |
|
| synchronizationInterval |
string |
A szinkronizálási intervallum (pl. "1d" a napi). Null, ha nincs konfigurálva ütemezés. |
| synchronizationStatus |
A jelenlegi szinkronizációs állapot. |
KnowledgeSourceSynchronizationError
Egy dokumentumszintű indexelési hibát képvisel, amely egy tudásforrás szinkronizációs futtatás során fordul elő.
| Név | Típus | Description |
|---|---|---|
| details |
string |
További kontextuális információk a kudarcról. |
| docId |
string |
A szinkronizálási folyamat során a meghibásodott dokumentum vagy elem egyedi azonosítója. |
| documentationLink |
string |
Link a releváns hibakeresési dokumentációhoz. |
| errorMessage |
string |
Emberi olvasható, ügyfél által látható hibaüzenet. |
| name |
string |
A hiba jelentését jelentő felvételi vagy feldolgozó komponens neve. |
| statusCode |
integer (int32) |
HTTP-szerű állapotkód, amely a hibakategóriát (pl. 400) képviseli. |
KnowledgeSourceSynchronizationStatus
A tudásforrás aktuális szinkronizálási állapota.
| Érték | Description |
|---|---|
| creating |
A tudásforrás kiépítése folyamatban van. |
| active |
A tudásforrás aktív, és szinkronizálási futtatások zajlanak. |
| deleting |
A tudásforrás törlődik, és a szinkronizálás szünetel. |
SynchronizationState
Egy folyamatban lévő szinkronizálás aktuális állapotát jelöli, amely több indexelő futtatására terjed ki.
| Név | Típus | Description |
|---|---|---|
| errors |
A jelenlegi szinkronizációs futtatás során tapasztalt dokumentumszintű indexelési hibák gyűjteménye. Csak akkor tér vissza, ha hibák vannak. |
|
| itemsSkipped |
integer (int32) |
Az aktuális szinkronizálás során kihagyott elemek száma. |
| itemsUpdatesFailed |
integer (int32) |
Az aktuális szinkronizálás során meghiúsult elemfrissítések száma. |
| itemsUpdatesProcessed |
integer (int32) |
Az aktuális szinkronizálás során sikeresen feldolgozott elemfrissítések száma. |
| startTime |
string (date-time) |
Az aktuális szinkronizálás kezdési időpontja. |