Knowledge Sources - Get Status

服務:: Search Service

API 版本:: 2026-04-01

取得知識來源的狀態。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	搜尋服務的端點 URL。
sourceName	path	True	string	知識來源的名稱。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求標頭

名稱	必要	類型	Description
Accept		Accept	接受標頭。
x-ms-client-request-id		string (uuid)	一個不透明、全域唯一、由客戶端產生的請求字串識別碼。

回應

名稱	類型	Description
200 OK	KnowledgeSourceStatus	要求已成功。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

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

範例要求

HTTP

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

範例回覆

狀態碼:: 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
  }
}

定義

名稱	Description
Accept	接受標頭。
CompletedSynchronizationState	代表上次同步處理的完成狀態。
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	所有 Azure Resource Manager API 的常見錯誤回應，用於回傳失敗操作的錯誤細節。（這也遵循 OData 錯誤回應格式。）。
KnowledgeSourceKind	知識來源的那種。
KnowledgeSourceStatistics	有關知識源同步歷史的統計信息。
KnowledgeSourceStatus	代表知識來源的狀態和同步處理歷程記錄。
KnowledgeSourceSynchronizationError	代表在知識來源同步執行時遇到的文件層級索引錯誤。
KnowledgeSourceSynchronizationStatus	知識來源的目前同步處理狀態。
SynchronizationState	代表跨越多個索引子執行之進行中同步處理的目前狀態。

Accept

列舉型別

接受標頭。

值	Description
application/json;odata.metadata=minimal

CompletedSynchronizationState

Object

代表上次同步處理的完成狀態。

名稱	類型	Description
endTime	string (date-time)	上次完成同步處理的結束時間。
itemsSkipped	integer (int32)	上次同步中略過的項目數。
itemsUpdatesFailed	integer (int32)	上次同步處理中失敗的項目更新數目。
itemsUpdatesProcessed	integer (int32)	上次同步處理中成功處理的項目更新數目。
startTime	string (date-time)	上次完成同步處理的開始時間。

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info		附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

所有 Azure Resource Manager API 的常見錯誤回應，用於回傳失敗操作的錯誤細節。（這也遵循 OData 錯誤回應格式。）。

名稱	類型	Description
error	ErrorDetail	錯誤物件。

KnowledgeSourceKind

列舉型別

知識來源的那種。

值	Description
searchIndex	從搜尋索引讀取資料的知識來源。
azureBlob	從 Azure Blob 儲存體讀取資料並將其擷取至搜尋索引的知識來源。
indexedOneLake	一個讀取索引 OneLake 資料的知識來源。
web	一個能從網路讀取資料的知識來源。

KnowledgeSourceStatistics

Object

有關知識源同步歷史的統計信息。

名稱	類型	Description
averageItemsProcessedPerSynchronization	integer (int32)	每次同步處理的平均項目。
averageSynchronizationDuration	string	HH：MM：SS 格式的平均同步時間。
totalSynchronization	integer (int32)	同步次數總數。

KnowledgeSourceStatus

Object

代表知識來源的狀態和同步處理歷程記錄。

名稱	類型	Description
currentSynchronizationState	SynchronizationState	跨越多個索引子執行的目前同步處理狀態。
kind	KnowledgeSourceKind	直接從狀態回應中識別知識來源類型。
lastSynchronizationState	CompletedSynchronizationState	上次完成同步處理的詳細資料。第一次同步處理時為 Null。
statistics	KnowledgeSourceStatistics	有關知識源同步歷史記錄的統計信息。第一次同步處理時為 Null。
synchronizationInterval	string	同步間隔（例如，每天的「1d」）。如果未設定排程，則為 Null。
synchronizationStatus	KnowledgeSourceSynchronizationStatus	目前的同步狀態。

KnowledgeSourceSynchronizationError

Object

代表在知識來源同步執行時遇到的文件層級索引錯誤。

名稱	類型	Description
details	string	關於這次失敗的額外背景資訊。
docId	string	同步執行中失敗文件或項目的唯一識別碼。
documentationLink	string	相關故障排除文件連結。
errorMessage	string	人類可讀、顧客可見的錯誤訊息。
name	string	報告錯誤的擷取或處理元件名稱。
statusCode	integer (int32)	類似 HTTP 的狀態碼代表故障類別（例如 400）。

KnowledgeSourceSynchronizationStatus

列舉型別

知識來源的目前同步處理狀態。

值	Description
creating	正在佈建知識來源。
active	知識來源處於作用中狀態，且正在進行同步化執行。
deleting	正在刪除知識來源，同步處理已暫停。

SynchronizationState

Object

代表跨越多個索引子執行之進行中同步處理的目前狀態。

名稱	類型	Description
errors	KnowledgeSourceSynchronizationError[]	目前同步執行中遇到的文件層級索引錯誤集合。僅在出現錯誤時返回。
itemsSkipped	integer (int32)	目前同步處理中略過的項目數。
itemsUpdatesFailed	integer (int32)	目前同步處理中失敗的項目更新數目。
itemsUpdatesProcessed	integer (int32)	目前同步處理中成功處理的項目更新數目。
startTime	string (date-time)	目前同步處理的開始時間。