インデクサーの状態の取得 (Azure AI Search REST API)

[アーティクル]
11/13/2023

インデクサー状態の取得 操作は、インデクサーの現在の状態と実行の履歴を取得します。

GET https://[service name].search.windows.net/indexers/[indexer name]/status?api-version=[api-version]&failIfCannotDecrypt=[true|false]
  Content-Type: application/json  
  api-key: [admin key]

URI パラメーター

パラメーター	説明
サービス名	必須。これを検索サービスの一意のユーザー定義名に設定します。
インデクサー名	必須。要求 URI は、状態を返すインデクサーの名前を指定します。
api-version	必須。現在の安定バージョンはです `api-version=2020-06-30`。その他のバージョンについては、「API のバージョン」を参照してください。
failIfCannotDecrypt	省略可能。指定しない場合、既定値は true です。暗号化キーを使用してインデクサーが作成され、検索サービスが暗号化キーにアクセスできない場合、インデクサーの状態の取得は失敗します。 false の場合、返されるインデクサーの状態には、暗号化されたプロパティがプレースホルダーに `"<encrypted>"` 置き換えられます。

要求ヘッダー

次の表では、必須と省略可能の要求ヘッダーについて説明します。

フィールド説明

Content-Type 必須。これを application/json

api-key Azure ロールを使用していて、要求でベアラートークンが提供されている場合は省略可能。それ以外の場合はキーが必要です。 api-key は、検索サービスに対する要求を認証する一意のシステム生成文字列です。オブジェクト定義の要求を取得するには、(クエリキーではなく) 管理キーに設定された api-key フィールドを含める必要があります。詳細については、「キー認証を使用して Azure AI Search に接続する」を参照してください。

フィールド	説明
Content-Type	必須。これを `application/json`
api-key	Azure ロールを使用していて、要求でベアラートークンが提供されている場合は省略可能。それ以外の場合はキーが必要です。 api-key は、検索サービスに対する要求を認証する一意のシステム生成文字列です。オブジェクト定義の要求を取得するには、(クエリキーではなく) 管理キーに設定された api-key フィールドを含める必要があります。詳細については、「キー認証を使用して Azure AI Search に接続する」を参照してください。

要求本文

[なし] :

Response

状態コード: 応答の成功に対して「200 OK」が返されます。応答本文には、インデクサーの全体的な正常性状態、最後のインデクサー呼び出し、最近のインデクサー呼び出しの履歴 (存在する場合) に関する情報が含まれます。

サンプルの応答本文は次のようになります。

{
    "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" : "",
                    "name" : "The operation name describing where the error occurred. For example, 'Enrichment.LanguageDetectionSkill.SkillName'",
                    "errorMessage" : "Document key cannot be missing or empty.",
                    "statusCode" : 400,
                    "details" : "Any additional details, such as the WebApi response if executing a custom skill failed.",
                    "documentationLink" : "A link to relevant documentation. For example, 'https://go.microsoft.com/fwlink/?linkid=2099692'""
                }
            ],
            "warnings" : [
                {
                    "key" : "document id",
                    "name" : "The operation name describing where the warning occurred. For example, 'Enrichment.LanguageDetectionSkill.SkillName'",
                    "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."
                    "details" : "Any additional details, such as the WebApi response if executing a custom skill failed.",
                    "documentationLink" : "A link to relevant documentation. For example, 'https://go.microsoft.com/fwlink/?linkid=2099692'"
                }
            ],
            "itemsProcessed" : 1,
            "itemsFailed" : 1,
            "initialTrackingState" : null,
            "finalTrackingState" : null
        }
    ]
}

注意

暗号化キーを使用してインデクサーが作成された場合、状態の暗号化されたプロパティは、検索サービスが暗号化キーにアクセスできる場合にのみ取得できます。検索サービスが暗号化キーにアクセスできない場合は、既定で 400 無効な要求が返されます。を指定 failIfCannotDecrypt=false して、暗号化されたプロパティを置き換えるプレースホルダーを使用 "<encrypted>" して状態を取得します。