Indexers - Get Status

服務:: Search Service

API 版本:: 2026-05-01-preview

傳回索引器目前的狀態和執行歷程記錄。

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2026-05-01-preview

URI 參數

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

要求標頭

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

回應

名稱	類型	Description
200 OK	SearchIndexerStatus	要求已成功。
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

範例

SearchServiceGetIndexerStatus

SearchServiceGetS3HDUnlimitedIndexerStatus

SearchServiceGetIndexerStatus

範例要求

HTTP

GET https://previewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-05-01-preview

範例回覆

狀態碼:: 200

{
  "name": "myindexer",
  "status": "running",
  "runtime": {
    "usedSeconds": 0,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "mode": "indexingAllDocs",
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "mode": "indexingAllDocs",
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "mode": "indexingAllDocs",
      "errors": [
        {
          "key": "",
          "statusCode": 400,
          "errorMessage": "Document key cannot be missing or empty."
        },
        {
          "key": "document id 1",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "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."
        },
        {
          "key": "document id 2",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "message": "Document was truncated to 50000 characters.",
          "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"
        }
      ]
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": []
  }
}

SearchServiceGetS3HDUnlimitedIndexerStatus

範例要求

HTTP

GET https://previewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2026-05-01-preview

範例回覆

狀態碼:: 200

{
  "name": "myindexer",
  "status": "running",
  "runtime": {
    "usedSeconds": 0,
    "remainingSeconds": 39600,
    "beginningTime": "2024-06-06T00:00:00.000Z",
    "endingTime": "2024-06-07T00:00:00.000Z"
  },
  "lastResult": {
    "status": "success",
    "startTime": "2014-11-26T03:37:18.853Z",
    "endTime": "2014-11-26T03:37:19.012Z",
    "itemsProcessed": 11,
    "itemsFailed": 0,
    "mode": "indexingAllDocs",
    "errors": [],
    "warnings": []
  },
  "executionHistory": [
    {
      "status": "success",
      "startTime": "2014-11-26T03:37:18.853Z",
      "endTime": "2014-11-26T03:37:19.012Z",
      "itemsProcessed": 11,
      "itemsFailed": 0,
      "mode": "indexingAllDocs",
      "errors": [],
      "warnings": []
    },
    {
      "status": "transientFailure",
      "startTime": "2014-11-26T03:28:10.125Z",
      "endTime": "2014-11-26T03:28:12.007Z",
      "itemsProcessed": 1,
      "itemsFailed": 2,
      "mode": "indexingAllDocs",
      "errors": [
        {
          "key": "",
          "statusCode": 400,
          "errorMessage": "Document key cannot be missing or empty."
        },
        {
          "key": "document id 1",
          "statusCode": 400,
          "name": "DocumentExtraction.AzureBlob.MyDataSource",
          "errorMessage": "Could not read the value of column 'foo' at index '0'.",
          "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."
        },
        {
          "key": "document id 2",
          "name": "Enrichment.LanguageDetectionSkill.#4",
          "message": "Document was truncated to 50000 characters.",
          "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"
        }
      ]
    }
  ],
  "limits": {
    "maxRunTime": "PT22H",
    "maxDocumentExtractionSize": 256000000,
    "maxDocumentContentCharactersToExtract": 4000000
  },
  "currentState": {
    "mode": "indexingAllDocs",
    "resetDocumentKeys": [],
    "resetDatasourceDocumentIds": []
  }
}

定義

名稱	Description
Accept	接受標頭。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。
IndexerCurrentState	表示定義及指定索引器目前執行的所有狀態。
IndexerExecutionResult	表示個別索引器執行的結果。
IndexerExecutionStatus	代表個別索引子執行的狀態。
IndexerExecutionStatusDetail	詳細說明個別索引子執行的狀態。
IndexerRuntime	代表索引子在服務中的累積執行階段耗用量。
IndexerStatus	代表整體索引子狀態。
IndexingMode	代表索引子執行的模式。
SearchIndexerError	表示專案或檔層級的索引編製錯誤。
SearchIndexerLimits	代表索引器可施加的限制。
SearchIndexerStatus	表示索引器目前的狀態和執行歷程記錄。
SearchIndexerWarning	表示專案層級警告。

Accept

列舉型別

接受標頭。

值	Description
application/json;odata.metadata=minimal

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	error 物件。

IndexerCurrentState

Object

表示定義及指定索引器目前執行的所有狀態。

名稱	類型	Description
allDocsFinalTrackingState	string	在數據源中的所有文件上編製索引完成時，變更追蹤狀態值。
allDocsInitialTrackingState	string	在數據源中的所有文件上開始編製索引時所使用的變更追蹤狀態。
mode	IndexingMode	索引器正在執行的模式。
resetDatasourceDocumentIds	string[]	已重設的數據源檔識別碼清單。數據源文件標識碼是數據源中數據的唯一標識碼。索引器會選擇性地重新擷取這些標識碼。
resetDocsFinalTrackingState	string	當索引編製完成時變更追蹤狀態值，請在選取時重設數據源中的檔。
resetDocsInitialTrackingState	string	變更索引編製開始於選取時所使用的追蹤狀態，重設數據源中的檔。
resetDocumentKeys	string[]	已重設的檔案索引鍵清單。檔索引鍵是搜尋索引中數據的檔唯一標識符。索引器會選擇性地重新擷取這些索引鍵。
resyncFinalTrackingState	string	變更資料來源中選擇性選項的索引完成時的追蹤狀態值。
resyncInitialTrackingState	string	在資料來源的選擇性選項上開始索引時使用的變更追蹤狀態。

IndexerExecutionResult

Object

表示個別索引器執行的結果。

名稱	類型	Description
endTime	string (date-time)	如果執行已完成，則為這個索引器執行的結束時間。
errorMessage	string	指出最上層錯誤的錯誤訊息，如果有的話。
errors	SearchIndexerError[]	專案層級的索引編製錯誤。
finalTrackingState	string	變更索引器執行完成的追蹤狀態。
initialTrackingState	string	變更索引器執行開始的追蹤狀態。
itemsFailed	integer (int32)	此索引器執行期間無法編製索引的項目數目。
itemsProcessed	integer (int32)	在這個索引器執行期間處理的項目數目。這包括成功處理的項目和嘗試編製索引但失敗的專案。
mode	IndexingMode	索引器正在執行的模式。
startTime	string (date-time)	這個索引器執行的開始時間。
status	IndexerExecutionStatus	這個索引器執行的結果。
statusDetail	IndexerExecutionStatusDetail	這個索引器執行的結果。
warnings	SearchIndexerWarning[]	專案層級的索引編製警告。

IndexerExecutionStatus

列舉型別

代表個別索引子執行的狀態。

值	Description
transientFailure	索引子調用失敗，但失敗可能是暫時性的。索引子調用將根據排程繼續進行。
success	索引子執行已順利完成。
inProgress	索引子執行正在進行中。
reset	索引子已重設。

IndexerExecutionStatusDetail

列舉型別

詳細說明個別索引子執行的狀態。

值	Description
resetDocs	表示發生的重設是針對 ResetDocs 的呼叫。
resync	表示根據資料來源中的選項選擇性地重新同步。

IndexerRuntime

Object

代表索引子在服務中的累積執行階段耗用量。

名稱	類型	Description
beginningTime	string (date-time)	24 小時期間的開始 UTC 時間，以考慮索引子執行階段使用量（含）。
endingTime	string (date-time)	針對索引子執行階段使用量（含）所考慮的 24 小時期間的結束 UTC 時間。
remainingSeconds	integer (int64)	服務中所有索引子從 startningTime 到 endingTime 的累積執行時間剩餘時間，以秒為單位。
usedSeconds	integer (int64)	索引器從一開始到結束時間的累積運行時間，單位為秒。

IndexerStatus

列舉型別

代表整體索引子狀態。

值	Description
unknown	表示索引子處於未知狀態。
error	表示索引子發生錯誤，如果沒有人為介入，就無法更正。
running	表示索引子正常執行。

IndexingMode

列舉型別

代表索引子執行的模式。

值	Description
indexingAllDocs	索引器正在為數據源中的所有文件編製索引。
indexingResetDocs	索引器正在為數據源中的文件編製選擇性索引、重設檔。所編製索引的文件定義於索引器狀態。
indexingResync	索引子正在重新同步處理和索引資料來源的選擇性選項（）。

SearchIndexerError

Object

表示專案或檔層級的索引編製錯誤。

名稱	類型	Description
details	string	此外，有關錯誤的詳細資訊，可協助偵錯索引器。這不一定是可用的。
documentationLink	string	這些錯誤類別疑難解答指南的連結。這不一定是可用的。
errorMessage	string	描述處理專案時發生錯誤的訊息。
key	string	索引編製失敗之專案的索引鍵。
name	string	產生錯誤的來源名稱。例如，這可能是指附加技能集中的特定技能。這不一定是可用的。
statusCode	integer (int32)	狀態代碼，指出索引作業失敗的原因。可能的值包括：400 表示格式錯誤的輸入檔、找不到檔的 404、版本衝突為 409、索引暫時無法使用時為 422，或服務忙碌時為 503。

SearchIndexerLimits

Object

代表索引器可施加的限制。

名稱	類型	Description
maxDocumentContentCharactersToExtract	integer (int64)	要從檔擷取以編製索引的字元數上限。
maxDocumentExtractionSize	integer (int64)	檔的大小上限，以位元組為單位，這會被視為有效的索引編制。
maxRunTime	string (duration)	索引器允許執行一次執行的最大持續時間。

SearchIndexerStatus

Object

表示索引器目前的狀態和執行歷程記錄。

名稱	類型	Description
currentState	IndexerCurrentState	定義和指示索引子目前執行的所有狀態。
executionHistory	IndexerExecutionResult[]	最近索引器執行的歷程記錄，依反向時間順序排序。
lastResult	IndexerExecutionResult	最近或進行中索引器執行的結果。
limits	SearchIndexerLimits	索引器的執行限制。
name	string	索引子的名稱。
runtime	IndexerRuntime	索引器在當前 UTC 期間內服務累積執行時消耗量的快照。
status	IndexerStatus	整體索引器狀態。

SearchIndexerWarning

Object

表示專案層級警告。

名稱	類型	Description
details	string	此外，有關警告的詳細資訊，可協助偵錯索引器。這不一定是可用的。
documentationLink	string	這些警告類別疑難解答指南的連結。這不一定是可用的。
key	string	產生警告之專案的索引鍵。
message	string	描述處理專案時所發生警告的訊息。
name	string	發出警告的來源名稱。例如，這可能是指附加技能集中的特定技能。這不一定是可用的。