列出 Azure AI 搜尋服務 REST API) (索引

列出索引作業會傳回 Azure AI 搜尋服務中目前索引的清單。

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

URI 參數

參數	Description
服務名稱	必要。 將此設定為搜尋服務的唯一使用者定義名稱。
api-version	必要。 目前的穩定版本是 api-version=2020-06-30 。 如需更多版本，請參閱 API 版本 。

要求標頭

下表說明必要及選用的要求標頭。

欄位	Description
Content-Type	必要。 請設為 application/json
api-key	如果您使用 Azure 角色 ，並在要求上提供持有人權杖，則為選擇性，否則需要金鑰。 API 金鑰是唯一的系統產生字串，可驗證對搜尋服務的要求。 取得物件定義的要求必須包含設定為系統管理員金鑰的 api 金鑰欄位， (而不是查詢金鑰) 。 如需詳細資訊，請參閱 使用金鑰驗證連線到 Azure AI 搜尋 服務。

要求本文

無。

回應

狀態碼：成功回應時會傳回 「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"},  
    ...  
  ]  
}  

如果您的搜尋服務中有很多索引，這個方法可以節省頻寬。

另請參閱

• Azure AI 搜尋 REST API