インデックス統計の取得 (Azure AI Search REST API)
インデックス統計の取得操作は、Azure AI Search から現在のインデックスのドキュメント数とストレージ使用量を返します。 ポータルからこの情報を取得することもできます。
注意
ドキュメントの数とストレージのサイズに関する統計情報は、リアルタイムではなく、数分おきに収集されます。 そのため、この 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-version=2020-06-30。 その他 のバージョンについては、「API のバージョン 」を参照してください。 |
要求ヘッダー
次の表では、必須と省略可能の要求ヘッダーについて説明します。
| フィールド | 説明 |
|---|---|
| Content-Type | 必須。 これを application/json |
| api-key | Azure ロールを使用していて、要求にベアラー トークンが指定されている場合は省略可能。それ以外の場合はキーが必要です。 api-key は、検索サービスに対する要求を認証する一意のシステム生成文字列です。 オブジェクト定義の要求を取得するには、(クエリ キーではなく) 管理キーに設定された api-key フィールドを含める必要があります。 詳細については、「 キー認証を使用して Azure AI Search に接続 する」を参照してください。 |
要求本文
[なし] :
Response
状態コード: 正常に応答するために "200 OK" が返されます。 応答本文の形式は次のとおりです。
{
"documentCount": number,
"storageSize": number (size of the index in bytes)
}