インデックスの一覧表示 (Azure Cognitive Search REST API)

List Indexes 操作は、Azure Cognitive Search サービスに現在あるインデックスの一覧を返します。

GET https://[service name].search.windows.net/indexes?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 必須。 api-key は、Search Serviceに対する要求を認証するために使用されます。 これはサービスに固有の文字列値です。 サービス内のオブジェクトに関する要求を取得するには、(クエリ キーではなく) 管理キーに設定された api-key フィールドを含める必要があります。 API キーは、Azure portalの検索サービス ダッシュボードで確認できます。

要求本文

[なし] :

Response

状態コード: "200 OK" が返され、応答が成功します。

{  
  "value": [  
    {  
      "name": "Books",  
      "fields": [  
        {"name": "ISBN", ...},  
        ...  
      ]  
    },  
    {  
      "name": "Games",  
      ...  
    },  
    ...  
  ]  
}  

目的のプロパティのみに応答をフィルター処理できます。 たとえば、インデックス名の一覧だけを必要とする場合、OData $select クエリ オプションを使用します。

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

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

{  
  "value": [  
    {"name": "Books"},  
    {"name": "Games"},  
    ...  
  ]  
}  

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

関連項目

Azure Cognitive Search REST API
インデックス操作 (AZURE COGNITIVE SEARCH REST API)