共用方式為

取得索引統計資料 （預覽 REST API）

  • 發行項

適用於：2023-07-01-Preview。 不再支援此版本。 立即 升級至較新版本。

重要

2023-07-01-Preview 會將 vectorIndexSize 範圍新增至索引。

取得索引統計數據 作業會傳回目前索引的檔計數，加上索引全部增加所使用的總記憶體數量，以及只由其向量數據取用的記憶體數量。 搜尋服務在取得服務統計數據 所報告之向量記憶體數量上具有整體限制。 “vectorIndexSize” 計量會告訴您目前搜尋索引中的向量欄位使用多少向量記憶體。

注意

每幾分鐘收集一次檔計數和記憶體大小的統計數據，而不是即時收集一次。 因此，此 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 參數

參數 描述
服務名稱 必填。 將此值設定為搜尋服務的唯一用戶定義名稱。
索引名稱 必填。 要求 URI 會指定應該傳回統計數據的索引名稱。
api-version 必填。 如需更多版本，請參閱 API 版本。

要求標頭

下表描述必要和選擇性的要求標頭。

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

要求本文

沒有。

回應

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

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

如果索引中沒有向量字段，“vectorIndexSize” 為零。

另請參閱