Knowledge Sources - Get Status
Odzyskuje status źródła wiedzy.
GET https:///knowledgesources('{sourceName}')/status?api-version=2025-11-01-preview
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
source
|
path | True |
string |
Nazwa źródła wiedzy. |
|
api-version
|
query | True |
string minLength: 1 |
Wersja interfejsu API do użycia dla tej operacji. |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Accept | True |
Nagłówek Accept. |
|
| x-ms-client-request-id |
string (uuid) |
Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
Żądanie zakończyło się pomyślnie. |
|
| Other Status Codes |
Nieoczekiwana odpowiedź na błąd. |
Zabezpieczenia
api-key
Typ:
apiKey
W:
header
OAuth2Auth
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Zakresów
| Nazwa | Opis |
|---|---|
| https://search.azure.com/.default |
Przykłady
SearchServiceGetKnowledgeSourceStatus
Przykładowe zapytanie
GET https:///knowledgesources('ks-preview-test')/status?api-version=2025-11-01-preview
Przykładowa odpowiedź
{
"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
}
}
Definicje
| Nazwa | Opis |
|---|---|
| Accept |
Nagłówek Accept. |
|
Completed |
Reprezentuje stan ukończenia ostatniej synchronizacji. |
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData). |
|
Knowledge |
Informacje statystyczne o historii synchronizacji źródeł wiedzy. |
|
Knowledge |
Reprezentuje stan i historię synchronizacji źródła wiedzy. |
|
Knowledge |
Bieżący stan synchronizacji źródła wiedzy. |
|
Synchronization |
Reprezentuje bieżący stan trwającej synchronizacji, która obejmuje wiele przebiegów indeksatora. |
Accept
Nagłówek Accept.
| Wartość | Opis |
|---|---|
| application/json;odata.metadata=minimal |
CompletedSynchronizationState
Reprezentuje stan ukończenia ostatniej synchronizacji.
| Nazwa | Typ | Opis |
|---|---|---|
| endTime |
string (date-time) |
Czas zakończenia ostatniej zakończonej synchronizacji. |
| itemsSkipped |
integer (int32) |
Liczba elementów pominiętych w ostatniej synchronizacji. |
| itemsUpdatesFailed |
integer (int32) |
Liczba aktualizacji elementów, które nie powiodły się podczas ostatniej synchronizacji. |
| itemsUpdatesProcessed |
integer (int32) |
Liczba aktualizacji elementów, które zostały pomyślnie przetworzone w ostatniej synchronizacji. |
| startTime |
string (date-time) |
Czas rozpoczęcia ostatniej zakończonej synchronizacji. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwa | Typ | Opis |
|---|---|---|
| info |
Dodatkowe informacje. |
|
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| additionalInfo |
Dodatkowe informacje o błędzie. |
|
| code |
string |
Kod błędu. |
| details |
Szczegóły błędu. |
|
| message |
string |
Komunikat o błędzie. |
| target |
string |
Element docelowy błędu. |
ErrorResponse
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
| Nazwa | Typ | Opis |
|---|---|---|
| error |
Obiekt błędu. |
KnowledgeSourceStatistics
Informacje statystyczne o historii synchronizacji źródeł wiedzy.
| Nazwa | Typ | Opis |
|---|---|---|
| averageItemsProcessedPerSynchronization |
integer (int32) |
Średnie elementy przetwarzane na synchronizację. |
| averageSynchronizationDuration |
string |
Średni czas synchronizacji w formacie HH:MM:SS. |
| totalSynchronization |
integer (int32) |
Łączna liczba synchronizacji. |
KnowledgeSourceStatus
Reprezentuje stan i historię synchronizacji źródła wiedzy.
| Nazwa | Typ | Opis |
|---|---|---|
| currentSynchronizationState |
Bieżący stan synchronizacji, który obejmuje wiele przebiegów indeksatora. |
|
| lastSynchronizationState |
Szczegóły ostatniej ukończonej synchronizacji. Wartość null przy pierwszej synchronizacji. |
|
| statistics |
Informacje statystyczne dotyczące historii synchronizacji źródła wiedzy. Wartość null przy pierwszej synchronizacji. |
|
| synchronizationInterval |
string |
Interwał synchronizacji (np. "1d" dla dziennego). Wartość null, jeśli nie skonfigurowano żadnego harmonogramu. |
| synchronizationStatus |
Aktualny status synchronizacji. |
KnowledgeSourceSynchronizationStatus
Bieżący stan synchronizacji źródła wiedzy.
| Wartość | Opis |
|---|---|
| creating |
Źródło wiedzy jest w trakcie apwizacji. |
| active |
Źródło wiedzy jest aktywne i są wykonywane przebiegi synchronizacji. |
| deleting |
Źródło wiedzy jest usuwane, a synchronizacja jest wstrzymywana. |
SynchronizationState
Reprezentuje bieżący stan trwającej synchronizacji, która obejmuje wiele przebiegów indeksatora.
| Nazwa | Typ | Opis |
|---|---|---|
| itemsSkipped |
integer (int32) |
Liczba elementów pominiętych w bieżącej synchronizacji. |
| itemsUpdatesFailed |
integer (int32) |
Liczba aktualizacji elementów, które nie powiodły się w bieżącej synchronizacji. |
| itemsUpdatesProcessed |
integer (int32) |
Liczba aktualizacji elementów pomyślnie przetworzonych w bieżącej synchronizacji. |
| startTime |
string (date-time) |
Czas rozpoczęcia bieżącej synchronizacji. |