次の方法で共有


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

インデクサーの取得操作は、Azure AI Search からインデクサー定義を取得します。

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

URI パラメーター

パラメーター 説明
サービス名 必須。 検索サービスの一意のユーザー定義名に設定します。
インデクサー名 必須。 要求 URI は、返すインデクサーの名前を指定します。
api-version サポートされている バージョンの 一覧については、「API のバージョン」を参照してください。

要求ヘッダー

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

フィールド 説明
Content-Type 必須。 application/json
api-key Azure ロールを使用していて、要求でベアラー トークンが提供されている場合は省略可能。それ以外の場合はキーが必要です。 API キーを使用している場合は、(クエリ キーではなく) 管理キーを指定して、検索サービスからオブジェクト情報を返します。 詳細については、「 キー認証を使用して Azure AI Search に接続 する」を参照してください。

要求本文

[なし] :

Response

状態コード: 応答の成功に対して「200 OK」が返されます。 応答は、 Create Indexer (Azure AI Search REST API) の例に似ています。

{  
    "name" : "myindexer",  
    "description" : "a cool indexer",  
    "dataSourceName" : "ordersds",  
    "targetIndexName" : "orders",  
    "schedule" : { "interval" : "PT1H", "startTime" : "2015-01-01T00:00:00Z" },  
    "parameters" : { "maxFailedItems" : 10, "maxFailedItemsPerBatch" : 5, "base64EncodeKeys": false },
    "encryptionKey": null
}  

注意

インデクサーに 暗号化キーがある場合、検索サービスは、インデクサー定義を取得するために暗号化キーにアクセスできる必要があります。 暗号化キーにアクセスしないと、400 無効な要求が返されます。 キーへのアクセスを復元すると、検索サービスはインデクサー定義を再度取得できます。

こちらもご覧ください