Indexers - Get Status

サービス:: Search Service

API バージョン:: 2025-11-01-preview

インデクサーの現在の状態と実行履歴を返します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	検索サービスのエンドポイント URL。
indexerName	path	True	string	インデクサーの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Accept		Accept	Acceptヘッダーです。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

応答

名前	型	説明
200 OK	SearchIndexerStatus	要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://search.azure.com/.default

例

SearchServiceGetIndexerStatus

SearchServiceGetS3HDUnlimitedIndexerStatus

SearchServiceGetIndexerStatus

要求のサンプル

HTTP

GET https://previewexampleservice.search.windows.net/indexers('myindexer')/search.status?api-version=2025-11-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=2025-11-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": []
  }
}

定義

名前	説明
Accept	Acceptヘッダーです。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
IndexerCurrentState	インデクサーの現在の実行を定義および決定するすべての状態を表します。
IndexerExecutionResult	個々のインデクサー実行の結果を表します。
IndexerExecutionStatus	個々のインデクサーの実行の状態を表します。
IndexerExecutionStatusDetail	個々のインデクサーの実行の状態を詳細に示します。
IndexerRuntime	サービスにおけるインデクサーの累積ランタイム消費量を表します。
IndexerStatus	全体的なインデクサーの状態を表します。
IndexingMode	インデクサーが実行されているモードを表します。
SearchIndexerError	アイテムレベルまたはドキュメントレベルのインデックス作成エラーを表します。
SearchIndexerLimits	インデクサーに適用可能な制限を表します。
SearchIndexerStatus	インデクサーの現在の状態と実行履歴を表します。
SearchIndexerWarning	項目レベルの警告を表します。

Accept

列挙

Acceptヘッダーです。

値	説明
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info		追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

IndexerCurrentState

Object

インデクサーの現在の実行を定義および決定するすべての状態を表します。

名前	型	説明
allDocsFinalTrackingState	string	データソース内のすべてのドキュメントでインデックス作成が完了したときに、追跡状態の値を変更します。
allDocsInitialTrackingState	string	データソース内のすべてのドキュメントでインデックス作成を開始するときに使用される変更追跡状態。
mode	IndexingMode	インデクサーが実行されているモード。
resetDatasourceDocumentIds	string[]	リセットされたデータソースドキュメント ID の一覧。データソースドキュメント ID は、データソース内のデータの一意識別子です。インデクサーは、これらの ID を選択的に再取り込みすることに優先順位を付けます。
resetDocsFinalTrackingState	string	選択時にインデックス作成が完了したときに追跡状態の値を変更し、データソース内のドキュメントをリセットします。
resetDocsInitialTrackingState	string	選択時にインデックス作成を開始するときに使用される追跡状態を変更し、データソース内のドキュメントをリセットします。
resetDocumentKeys	string[]	リセットされたドキュメントキーの一覧。ドキュメントキーは、検索インデックス内のデータに対するドキュメントの一意識別子です。インデクサーは、これらのキーを選択的に再取り込みすることに優先順位を付けます。
resyncFinalTrackingState	string	データソースからの選択されたオプションでインデックス作成が終了したときに、追跡状態の値を変更します。
resyncInitialTrackingState	string	データソースからの選択オプションでインデックス作成を開始するときに使用される変更追跡状態。

IndexerExecutionResult

Object

個々のインデクサー実行の結果を表します。

名前	型	説明
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

列挙

個々のインデクサーの実行の状態を表します。

値	説明
transientFailure	インデクサーの呼び出しは失敗しましたが、失敗は一時的なものである可能性があります。インデクサーの呼び出しは、スケジュールに従って続行されます。
success	インデクサーの実行は正常に完了しました。
inProgress	インデクサーの実行が進行中です。
reset	インデクサーがリセットされました。

IndexerExecutionStatusDetail

列挙

個々のインデクサーの実行の状態を詳細に示します。

値	説明
resetDocs	発生したリセットが ResetDocs の呼び出しに対して行われたことを示します。
resync	データソースのオプションに基づいて選択的に再同期することを示します。

IndexerRuntime

Object

サービスにおけるインデクサーの累積ランタイム消費量を表します。

名前	型	説明
beginningTime	string (date-time)	インデクサーのランタイム使用量 (両端を含む) として考慮される 24 時間期間の開始 UTC 時刻。
endingTime	string (date-time)	インデクサーランタイムの使用量 (両端を含む) として考慮される 24 時間の終了 UTC 時刻。
remainingSeconds	integer (int64)	サービス内のすべてのインデクサーの startningTime から endingTime までの累積ランタイムの残り時間 (秒単位)。
usedSeconds	integer (int64)	インデクサーの initingTime から endingTime までの累積実行時間 (秒単位)。

IndexerStatus

列挙

全体的なインデクサーの状態を表します。

値	説明
unknown	インデクサーが不明な状態であることを示します。
error	インデクサーで、人間の介入なしには修正できないエラーが発生したことを示します。
running	インデクサーが正常に実行されていることを示します。

IndexingMode

列挙

インデクサーが実行されているモードを表します。

値	説明
indexingAllDocs	インデクサーは、データソース内のすべてのドキュメントにインデックスを作成しています。
indexingResetDocs	インデクサーは、選択的なインデックス作成を行い、データソース内のドキュメントをリセットします。インデックスが作成されるドキュメントは、インデクサーの状態で定義されます。
indexingResync	インデクサーは、データソースから選択オプションを再同期し、インデックスを作成しています。

SearchIndexerError

Object

アイテムレベルまたはドキュメントレベルのインデックス作成エラーを表します。

名前	型	説明
details	string	インデクサーのデバッグに役立つエラーに関する追加の詳細な詳細。これは常に利用できるとは限りません。
documentationLink	string	これらのクラスのエラーのトラブルシューティングガイドへのリンク。これは常に利用できるとは限りません。
errorMessage	string	アイテムの処理中に発生したエラーを説明するメッセージ。
key	string	インデックス作成に失敗した項目のキー。
name	string	エラーの発生元の名前。たとえば、これは、添付されたスキルセットの特定のスキルを参照できます。これは常に利用できるとは限りません。
statusCode	integer (int32)	インデックス作成操作が失敗した理由を示す状態コード。指定できる値には、形式が正しくない入力ドキュメントの場合は 400、ドキュメントが見つからない場合は 404、バージョンの競合の場合は 409、インデックスが一時的に使用できない場合は 422、サービスがビジー状態の場合は 503 などがあります。

SearchIndexerLimits

Object

インデクサーに適用可能な制限を表します。

名前	型	説明
maxDocumentContentCharactersToExtract	integer (int64)	インデックス作成のために取得されたドキュメントから抽出される最大文字数。
maxDocumentExtractionSize	integer (int64)	インデックス作成に有効と見なされるドキュメントの最大サイズ (バイト単位)。
maxRunTime	string (duration)	インデクサーが 1 回の実行で実行できる最大期間。

SearchIndexerStatus

Object

インデクサーの現在の状態と実行履歴を表します。

名前	型	説明
currentState	IndexerCurrentState	インデクサーの現在の実行を定義および指示するすべての状態。
executionHistory	IndexerExecutionResult[]	最近のインデクサー実行の履歴。時系列の逆順に並べ替えられます。
lastResult	IndexerExecutionResult	最新または進行中のインデクサー実行の結果。
limits	SearchIndexerLimits	インデクサーの実行制限。
name	string	インデクサーの名前。
runtime	IndexerRuntime	現在のUTC期間におけるサービスのインデクサーの累積ランタイム消費のスナップショット。
status	IndexerStatus	インデクサーの全体的な状態。

SearchIndexerWarning

Object

項目レベルの警告を表します。

名前	型	説明
details	string	インデクサーのデバッグに役立つ警告に関する追加の詳細な情報。これは常に利用できるとは限りません。
documentationLink	string	これらのクラスの警告のトラブルシューティングガイドへのリンク。これは常に利用できるとは限りません。
key	string	警告を生成した項目のキー。
message	string	アイテムの処理中に発生した警告を説明するメッセージ。
name	string	警告が発生したソースの名前。たとえば、これは、添付されたスキルセットの特定のスキルを参照できます。これは常に利用できるとは限りません。