次の方法で共有


Indexers - Get Status

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

GET {endpoint}/indexers('{indexerName}')/search.status?api-version=2024-07-01

URI パラメーター

名前 / 必須 説明
endpoint
path True

string

検索サービスのエンドポイント URL。

indexerName
path True

string

状態を取得するインデクサーの名前。

api-version
query True

string

クライアント API のバージョン。

要求ヘッダー

名前 必須 説明
x-ms-client-request-id

string

uuid

デバッグに役立つ要求と共に送信される追跡 ID。

応答

名前 説明
200 OK

SearchIndexerStatus

Other Status Codes

ErrorResponse

エラー応答。

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
  }
}

定義

名前 説明
ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

IndexerExecutionResult

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

IndexerExecutionStatus

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

IndexerStatus

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

SearchIndexerError

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

SearchIndexerLimits
SearchIndexerStatus

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

SearchIndexerWarning

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

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

エラー オブジェクト。

IndexerExecutionResult

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

名前 説明
endTime

string

このインデクサー実行の終了時刻 (実行が既に完了している場合)。

errorMessage

string

最上位レベルのエラー (存在する場合) を示すエラー メッセージ。

errors

SearchIndexerError[]

項目レベルのインデックス作成エラー。

finalTrackingState

string

インデクサーの実行が完了した追跡状態を変更します。

initialTrackingState

string

インデクサーの実行が開始された追跡状態を変更します。

itemsFailed

integer

このインデクサーの実行中にインデックスを作成できなかった項目の数。

itemsProcessed

integer

このインデクサーの実行中に処理された項目の数。 これには、正常に処理された項目と、インデックス作成が試行されたが失敗した項目の両方が含まれます。

startTime

string

このインデクサー実行の開始時刻。

status

IndexerExecutionStatus

このインデクサー実行の結果。

warnings

SearchIndexerWarning[]

項目レベルのインデックス作成の警告。

IndexerExecutionStatus

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

名前 説明
inProgress

string

インデクサーの実行が進行中です。

reset

string

インデクサーがリセットされました。

success

string

インデクサーの実行が正常に完了しました。

transientFailure

string

インデクサーの呼び出しは失敗しましたが、エラーは一時的なものである可能性があります。 インデクサーの呼び出しは、スケジュールごとに続行されます。

IndexerStatus

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

名前 説明
error

string

インデクサーで、人間の介入なしには修正できないエラーが発生したことを示します。

running

string

インデクサーが正常に実行されていることを示します。

unknown

string

インデクサーが不明な状態であることを示します。

SearchIndexerError

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

名前 説明
details

string

インデクサーのデバッグに役立つエラーに関する詳細な詳細。 これは常に使用できるわけではありません。

documentationLink

string

これらのクラスのエラーのトラブルシューティング ガイドへのリンク。 これは常に使用できるわけではありません。

errorMessage

string

アイテムの処理中に発生したエラーを説明するメッセージ。

key

string

インデックス作成に失敗した項目のキー。

name

string

エラーが発生したソースの名前。 たとえば、アタッチされたスキルセット内の特定のスキルを参照できます。 これは常に使用できるわけではありません。

statusCode

integer

インデックス作成操作が失敗した理由を示す状態コード。 指定できる値は、形式が正しくない入力ドキュメントの場合は 400、ドキュメントが見つからない場合は 404、バージョンの競合の場合は 409、インデックスが一時的に使用できない場合は 422、サービスがビジー状態の場合は 503 です。

SearchIndexerLimits

名前 説明
maxDocumentContentCharactersToExtract

number

インデックス作成のために取得したドキュメントから抽出される最大文字数。

maxDocumentExtractionSize

number

インデックス作成に有効と見なされるドキュメントの最大サイズ (バイト単位)。

maxRunTime

string

インデクサーが 1 回の実行に対して実行できる最大期間。

SearchIndexerStatus

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

名前 説明
executionHistory

IndexerExecutionResult[]

最近のインデクサー実行の履歴。時系列の逆順に並べ替えられます。

lastResult

IndexerExecutionResult

最新または進行中のインデクサー実行の結果。

limits

SearchIndexerLimits

インデクサーの実行制限。

status

IndexerStatus

インデクサーの全体的な状態。

SearchIndexerWarning

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

名前 説明
details

string

インデクサーのデバッグに役立つ警告に関する詳細な詳細情報。 これは常に使用できるわけではありません。

documentationLink

string

これらの警告クラスのトラブルシューティング ガイドへのリンク。 これは常に使用できるわけではありません。

key

string

警告を生成した項目のキー。

message

string

アイテムの処理中に発生した警告を説明するメッセージ。

name

string

警告が発生したソースの名前。 たとえば、アタッチされたスキルセット内の特定のスキルを参照できます。 これは常に使用できるわけではありません。