次の方法で共有


インデクサーの一覧表示 (Azure AI Search REST API)

List Indexers 操作は、Azure AI Search Service内のインデクサーの一覧を返します。

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

URI パラメーター

パラメーター 説明
サービス名 必須。 これを検索サービスの一意のユーザー定義名に設定します。
api-version 必須。 現在の安定バージョンは です api-version=2020-06-30。 その他 のバージョンについては、「API のバージョン 」を参照してください。

要求ヘッダー

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

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

要求本文

[なし] :

Response

要求成功の場合: 200 OK。 次は応答本文の例です。

{  
      "value" : [  
      {  
        "name" : "myindexer",  
        "description" : "a cool indexer",  
        "dataSourceName" : "ordersds",  
        "targetIndexName" : "orders",  
        ... other indexer properties  
      }]  
    }  

応答をフィルター処理して、関心のあるプロパティだけを絞り込むことができます。 たとえば、インデクサー名の一覧のみが必要な場合は、OData $select クエリ オプションを使用します。

GET /indexers?api-version=2020-06-30&$select=name  

この場合は、上記の例の応答は次のように表示されます。

{  
      "value" : [ { "name": "myindexer" } ]  
    }  

これは、Search サービスにインデクサーがたくさんある場合、帯域幅を節約する便利な方法となります。

注意

インデクサーに 暗号化キーがある場合、検索サービスは、そのインデクサーの定義で暗号化されたプロパティを取得するために暗号化キーにアクセスできる必要があります。 暗号化キーにアクセスしないと、 "<encrypted>" 暗号化されたプロパティの代わりにプレースホルダーが返されます。 キーへのアクセスを復元すると、検索サービスは完全なインデクサー定義を再度取得できます。

関連項目