取得 Azure AI 搜尋服務 REST API (索引統計資料)

取得索引統計資料作業會從 Azure AI 搜尋傳回目前索引的檔計數，以及儲存體使用量。 您也可以從入口網站取得此資訊。

注意

文件計數和儲存體大小的統計資料會每隔幾分鐘收集，不會即時收集。 因此，此 API 所傳回的統計資料可能不會反映最新的索引作業所造成的變更。

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

URI 參數

參數	Description
服務名稱	必要。 將此設定為搜尋服務的唯一使用者定義名稱。
索引名稱	必要。 要求 URI 會指定應該傳回統計資料的索引名稱。
api-version	必要。 目前的穩定版本為 api-version=2020-06-30 。 如需更多版本，請參閱 API 版本 。

要求標頭

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

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

要求本文

無。

回應

狀態碼：傳回 「200 OK」 以取得成功的回應。 回應本文的格式如下：

{  
  "documentCount": number,  
  "storageSize": number (size of the index in bytes)  
}  

另請參閱

• Azure AI 搜尋 REST API