Knowledge Sources - Get Status
取得知識來源的狀態。
GET https:///knowledgesources('{sourceName}')/status?api-version=2025-11-01-previewURI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
source
|
path | True |
string |
知識來源的名稱。 |
|
api-version
|
query | True |
string minLength: 1 |
用於此作業的 API 版本。 |
要求標頭
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| Accept | True |
接受標頭。 |
|
| x-ms-client-request-id |
string (uuid) |
要求不透明、全域唯一、用戶端產生的字串標識碼。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
要求已成功。 |
|
| Other Status Codes |
未預期的錯誤回應。 |
安全性
api-key
類型:
apiKey
位於:
header
OAuth2Auth
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
範圍
| 名稱 | Description |
|---|---|
| https://search.azure.com/.default |
範例
SearchServiceGetKnowledgeSourceStatus
範例要求
GET https:///knowledgesources('ks-preview-test')/status?api-version=2025-11-01-preview
範例回覆
{
"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
}
}定義
| 名稱 | Description |
|---|---|
| Accept |
接受標頭。 |
|
Completed |
代表上次同步處理的完成狀態。 |
|
Error |
資源管理錯誤其他資訊。 |
|
Error |
錯誤詳細數據。 |
|
Error |
所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 （這也遵循 OData 錯誤回應格式。）。 |
|
Knowledge |
有關知識源同步歷史的統計信息。 |
|
Knowledge |
代表知識來源的狀態和同步處理歷程記錄。 |
|
Knowledge |
知識來源的目前同步處理狀態。 |
|
Synchronization |
代表跨越多個索引子執行之進行中同步處理的目前狀態。 |
Accept
接受標頭。
| 值 | Description |
|---|---|
| application/json;odata.metadata=minimal |
CompletedSynchronizationState
代表上次同步處理的完成狀態。
| 名稱 | 類型 | Description |
|---|---|---|
| endTime |
string (date-time) |
上次完成同步處理的結束時間。 |
| itemsSkipped |
integer (int32) |
上次同步中略過的項目數。 |
| itemsUpdatesFailed |
integer (int32) |
上次同步處理中失敗的項目更新數目。 |
| itemsUpdatesProcessed |
integer (int32) |
上次同步處理中成功處理的項目更新數目。 |
| startTime |
string (date-time) |
上次完成同步處理的開始時間。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| info |
附加資訊。 |
|
| type |
string |
其他資訊類型。 |
ErrorDetail
錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalInfo |
錯誤附加資訊。 |
|
| code |
string |
錯誤碼。 |
| details |
錯誤詳細數據。 |
|
| message |
string |
錯誤訊息。 |
| target |
string |
錯誤目標。 |
ErrorResponse
所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 （這也遵循 OData 錯誤回應格式。）。
| 名稱 | 類型 | Description |
|---|---|---|
| error |
錯誤物件。 |
KnowledgeSourceStatistics
有關知識源同步歷史的統計信息。
| 名稱 | 類型 | Description |
|---|---|---|
| averageItemsProcessedPerSynchronization |
integer (int32) |
每次同步處理的平均項目。 |
| averageSynchronizationDuration |
string |
HH：MM：SS 格式的平均同步時間。 |
| totalSynchronization |
integer (int32) |
同步次數總數。 |
KnowledgeSourceStatus
代表知識來源的狀態和同步處理歷程記錄。
| 名稱 | 類型 | Description |
|---|---|---|
| currentSynchronizationState |
跨越多個索引子執行的目前同步處理狀態。 |
|
| lastSynchronizationState |
上次完成同步處理的詳細資料。 第一次同步處理時為 Null。 |
|
| statistics |
有關知識源同步歷史記錄的統計信息。 第一次同步處理時為 Null。 |
|
| synchronizationInterval |
string |
同步間隔（例如，每天的「1d」）。 如果未設定排程，則為 Null。 |
| synchronizationStatus |
目前的同步狀態。 |
KnowledgeSourceSynchronizationStatus
知識來源的目前同步處理狀態。
| 值 | Description |
|---|---|
| creating |
正在佈建知識來源。 |
| active |
知識來源處於作用中狀態，且正在進行同步化執行。 |
| deleting |
正在刪除知識來源，同步處理已暫停。 |
SynchronizationState
代表跨越多個索引子執行之進行中同步處理的目前狀態。
| 名稱 | 類型 | Description |
|---|---|---|
| itemsSkipped |
integer (int32) |
目前同步處理中略過的項目數。 |
| itemsUpdatesFailed |
integer (int32) |
目前同步處理中失敗的項目更新數目。 |
| itemsUpdatesProcessed |
integer (int32) |
目前同步處理中成功處理的項目更新數目。 |
| startTime |
string (date-time) |
目前同步處理的開始時間。 |