取得 Azure AI 搜尋 REST API (索引)
取得索引作業會從 Azure AI 搜尋服務取得索引定義。
GET https://[service name].search.windows.net/indexes/[index name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI 參數
參數 | Description |
---|---|
服務名稱 | 必要。 將此設定為搜尋服務的唯一用戶定義名稱。 |
索引名稱 | 必要。 要求 URI 會指定要傳回之索引的名稱。 |
api-version | 必要。 如需支援的版本清單,請參閱 API 版本 。 |
要求標頭
下表說明必要及選用的要求標頭。
欄位 | Description |
---|---|
Content-Type | 必要。 請設為 application/json |
api-key | 如果您使用 Azure 角色 ,而且要求會提供持有人令牌,則為選擇性,否則需要密鑰。 如果您使用 API 金鑰,請指定系統管理員金鑰 (,而不是查詢金鑰,) 從搜尋服務傳回物件資訊。 如需詳細資訊 ,請參閱使用密鑰驗證連線到 Azure AI 搜尋 服務。 |
要求本文
無。
回應
狀態代碼:傳回 「200 OK」 以取得成功的回應。 如需響應承載範例,請參閱建立 索引 (Azure AI 搜尋 REST API) 中的範例要求 JSON。 取得索引回應本文和建立索引回應和響應主體都是相同的格式。