Indexers - Get Status
傳回索引器目前的狀態和執行歷程記錄。
GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2024-07-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
搜尋服務的端點 URL。 |
indexer
|
path | True |
string |
要為其擷取狀態的索引器名稱。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
隨要求一起傳送的追蹤標識碼,以協助偵錯。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK | ||
Other Status Codes |
錯誤回應。 |
範例
SearchServiceGetIndexerStatus
範例要求
GET https://myservice.search.windows.net/indexers('myindexer')/search.status?api-version=2024-07-01
範例回覆
{
"status": "running",
"lastResult": {
"status": "success",
"errorMessage": null,
"startTime": "2014-11-26T03:37:18.853Z",
"endTime": "2014-11-26T03:37:19.012Z",
"errors": [],
"warnings": [],
"itemsProcessed": 11,
"itemsFailed": 0,
"initialTrackingState": null,
"finalTrackingState": null
},
"executionHistory": [
{
"status": "success",
"errorMessage": null,
"startTime": "2014-11-26T03:37:18.853Z",
"endTime": "2014-11-26T03:37:19.012Z",
"errors": [],
"warnings": [],
"itemsProcessed": 11,
"itemsFailed": 0,
"initialTrackingState": null,
"finalTrackingState": null
},
{
"status": "transientFailure",
"errorMessage": null,
"startTime": "2014-11-26T03:28:10.125Z",
"endTime": "2014-11-26T03:28:12.007Z",
"errors": [
{
"key": "",
"errorMessage": "Document key cannot be missing or empty.",
"statusCode": 400,
"name": null,
"details": null,
"documentationLink": null
},
{
"key": "document id 1",
"errorMessage": "Could not read the value of column 'foo' at index '0'.",
"statusCode": 400,
"name": "DocumentExtraction.AzureBlob.MyDataSource",
"details": "The file could not be parsed.",
"documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388"
}
],
"warnings": [
{
"key": "document id",
"message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob.",
"name": null,
"details": null,
"documentationLink": null
},
{
"key": "document id 2",
"message": "Document was truncated to 50000 characters.",
"name": "Enrichment.LanguageDetectionSkill.#4",
"details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.",
"documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692"
}
],
"itemsProcessed": 1,
"itemsFailed": 2,
"initialTrackingState": null,
"finalTrackingState": null
}
],
"limits": {
"maxRunTime": "PT22H",
"maxDocumentExtractionSize": 256000000,
"maxDocumentContentCharactersToExtract": 4000000
}
}
定義
名稱 | Description |
---|---|
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Indexer |
表示個別索引器執行的結果。 |
Indexer |
表示個別索引器執行的狀態。 |
Indexer |
表示整體索引器狀態。 |
Search |
表示專案或檔層級的索引編製錯誤。 |
Search |
|
Search |
表示索引器目前的狀態和執行歷程記錄。 |
Search |
表示專案層級警告。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細數據。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
IndexerExecutionResult
表示個別索引器執行的結果。
名稱 | 類型 | Description |
---|---|---|
endTime |
string |
如果執行已完成,則為這個索引器執行的結束時間。 |
errorMessage |
string |
指出最上層錯誤的錯誤訊息,如果有的話。 |
errors |
專案層級的索引編製錯誤。 |
|
finalTrackingState |
string |
變更索引器執行完成的追蹤狀態。 |
initialTrackingState |
string |
變更索引器執行開始的追蹤狀態。 |
itemsFailed |
integer |
此索引器執行期間無法編製索引的項目數目。 |
itemsProcessed |
integer |
在這個索引器執行期間處理的項目數目。 這包括成功處理的項目和嘗試編製索引但失敗的專案。 |
startTime |
string |
這個索引器執行的開始時間。 |
status |
這個索引器執行的結果。 |
|
warnings |
專案層級的索引編製警告。 |
IndexerExecutionStatus
表示個別索引器執行的狀態。
名稱 | 類型 | Description |
---|---|---|
inProgress |
string |
索引器執行正在進行中。 |
reset |
string |
索引器已重設。 |
success |
string |
索引器執行已順利完成。 |
transientFailure |
string |
索引器調用失敗,但失敗可能是暫時性的。 索引器調用會繼續每個排程。 |
IndexerStatus
表示整體索引器狀態。
名稱 | 類型 | Description |
---|---|---|
error |
string |
表示索引器發生錯誤,而不需要人為介入便無法更正。 |
running |
string |
表示索引器正常執行。 |
unknown |
string |
表示索引器處於未知狀態。 |
SearchIndexerError
表示專案或檔層級的索引編製錯誤。
名稱 | 類型 | Description |
---|---|---|
details |
string |
此外,有關錯誤的詳細資訊,可協助偵錯索引器。 這不一定是可用的。 |
documentationLink |
string |
這些錯誤類別疑難解答指南的連結。 這不一定是可用的。 |
errorMessage |
string |
描述處理專案時發生錯誤的訊息。 |
key |
string |
索引編製失敗之專案的索引鍵。 |
name |
string |
產生錯誤的來源名稱。 例如,這可能是指附加技能集中的特定技能。 這不一定是可用的。 |
statusCode |
integer |
狀態代碼,指出索引作業失敗的原因。 可能的值包括:400 表示格式錯誤的輸入檔、找不到檔的 404、版本衝突為 409、索引暫時無法使用時為 422,或服務忙碌時為 503。 |
SearchIndexerLimits
名稱 | 類型 | Description |
---|---|---|
maxDocumentContentCharactersToExtract |
number |
要從檔擷取以編製索引的字元數上限。 |
maxDocumentExtractionSize |
number |
檔的大小上限,以位元組為單位,這會被視為有效的索引編制。 |
maxRunTime |
string |
索引器允許執行一次執行的最大持續時間。 |
SearchIndexerStatus
表示索引器目前的狀態和執行歷程記錄。
名稱 | 類型 | Description |
---|---|---|
executionHistory |
最近索引器執行的歷程記錄,依反向時間順序排序。 |
|
lastResult |
最近或進行中索引器執行的結果。 |
|
limits |
索引器的執行限制。 |
|
status |
整體索引器狀態。 |
SearchIndexerWarning
表示專案層級警告。
名稱 | 類型 | Description |
---|---|---|
details |
string |
此外,有關警告的詳細資訊,可協助偵錯索引器。 這不一定是可用的。 |
documentationLink |
string |
這些警告類別疑難解答指南的連結。 這不一定是可用的。 |
key |
string |
產生警告之專案的索引鍵。 |
message |
string |
描述處理專案時所發生警告的訊息。 |
name |
string |
發出警告的來源名稱。 例如,這可能是指附加技能集中的特定技能。 這不一定是可用的。 |