Indexes - Get Statistics

サービス:

Search Service

API バージョン:

2024-05-01-preview

ドキュメント数やストレージ使用量など、指定されたインデックスの統計を返します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	検索サービスのエンドポイント URL。
indexName	path	True	string	統計を取得するインデックスの名前。
api-version	query	True	string	クライアント API のバージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string uuid	デバッグに役立つ要求と共に送信される追跡 ID。

応答

名前	型	説明
200 OK	GetIndexStatisticsResult
Other Status Codes	ErrorResponse	エラー応答。

例

SearchServiceGetIndexStatistics

要求のサンプル

HTTP

GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2024-05-01-preview

応答のサンプル

状態コード:

200

{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GetIndexStatisticsResult	特定のインデックスの統計。 統計は定期的に収集され、常に最新であるとは限りません。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

GetIndexStatisticsResult

特定のインデックスの統計。 統計は定期的に収集され、常に最新であるとは限りません。

名前	型	説明
documentCount	integer	インデックス内のドキュメントの数。
storageSize	integer	インデックスによって消費されるストレージの量 (バイト単位)。
vectorIndexSize	integer	インデックス内のベクトルによって消費されるメモリの量 (バイト単位)。