Indexes - Get Statistics

服務:

Search Service

API 版本:

2024-11-01-preview

傳回指定索引的統計數據，包括檔計數和記憶體使用量。

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2024-11-01-preview

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	搜尋服務的端點 URL。
indexName	path	True	string	要擷取統計數據的索引名稱。
api-version	query	True	string	用戶端 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	隨要求一起傳送的追蹤標識碼，以協助偵錯。

回應

名稱	類型	Description
200 OK	GetIndexStatisticsResult
Other Status Codes	ErrorResponse	錯誤回應。

範例

SearchServiceGetIndexStatistics

範例要求

HTTP

GET https://previewexampleservice.search.windows.net/indexes('preview-test')/search.stats?api-version=2024-11-01-preview

範例回覆

狀態碼:

200

{
  "documentCount": 12,
  "storageSize": 123456,
  "vectorIndexSize": 123456
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GetIndexStatisticsResult	指定索引的統計數據。 統計數據會定期收集，不保證一律 up-to-date。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

GetIndexStatisticsResult

指定索引的統計數據。 統計數據會定期收集，不保證一律 up-to-date。

名稱	類型	Description
documentCount	integer	索引中的文件數目。
storageSize	integer	索引所耗用位元組的記憶體數量。
vectorIndexSize	integer	索引中向量所耗用的位元組記憶體數量。