Indexes - Get Statistics
ドキュメント数やストレージ使用量など、指定されたインデックスの統計を返します。
GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2026-04-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
検索サービスのエンドポイント URL。 |
|
index
|
path | True |
string |
インデックスの名前。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| Accept |
Acceptヘッダーです。 |
||
| x-ms-client-request-id |
string (uuid) |
要求の非透過的なグローバルに一意のクライアント生成文字列識別子。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求は成功しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
api-key
型:
apiKey
/:
header
OAuth2Auth
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
スコープ
| 名前 | 説明 |
|---|---|
| https://search.azure.com/.default |
例
SearchServiceGetIndexStatistics
要求のサンプル
GET https://exampleservice.search.windows.net/indexes('example-index')/search.stats?api-version=2026-04-01
応答のサンプル
{
"documentCount": 12,
"storageSize": 123456,
"vectorIndexSize": 123456
}
定義
| 名前 | 説明 |
|---|---|
| Accept |
Acceptヘッダーです。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。 |
|
Get |
特定のインデックスの統計。 統計は定期的に収集され、常に -date up-toされるとは限りません。 |
Accept
Acceptヘッダーです。
| 値 | 説明 |
|---|---|
| application/json;odata.metadata=minimal |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
追加情報。 |
|
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
GetIndexStatisticsResult
特定のインデックスの統計。 統計は定期的に収集され、常に -date up-toされるとは限りません。
| 名前 | 型 | 説明 |
|---|---|---|
| documentCount |
integer (int64) |
インデックス内のドキュメントの数。 |
| storageSize |
integer (int64) |
インデックスによって消費されるストレージの量 (バイト単位)。 |
| vectorIndexSize |
integer (int64) |
インデックス内のベクトルによって消費されるメモリの量(バイト単位)。 |