サービス統計の取得 (REST API のプレビュー)
適用対象: 2023-07-01-Preview、2021-04-30-Preview
重要
2023-07-01-Preview は、検索サービスに スコープが設定された vectorIndexSize を追加します。
2021-04-30-Preview では aliasesCount が追加されます。
サービス統計操作は、サービス内のオブジェクトの数と種類、サービス レベル、実際のストレージと最大ストレージ、および層によって異なるその他の制限を指定した各オブジェクトの種類に対して許可される最大値を返します。 この要求は、サービスの制限を検索または計算する必要がないように 、サービスから情報を取得します。
ドキュメントの数とストレージのサイズに関する統計情報は、リアルタイムではなく、数分おきに収集されます。 そのため、この API が返す統計情報には、最近のインデックス作成操作による変更内容が反映されていない場合があります。
GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI パラメーター
| パラメーター | 説明 |
|---|---|
| サービス名 | 必須。 この値を、検索サービスの一意のユーザー定義名に設定します。 要求 URI は、統計を返すインデックスの名前を指定します。 |
| api-version | 必須。 現在のプレビュー バージョンは です 2023-07-01-Preview。 その他 のバージョンについては、「API のバージョン 」を参照してください。 |
要求ヘッダー
次の表では、必須と省略可能の要求ヘッダーについて説明します。
| フィールド | 説明 |
|---|---|
| Content-Type | 必須。 この値を に設定します。 application/json |
| api-key | Azure ロールを使用していて、要求にベアラー トークンが指定されている場合は省略可能。それ以外の場合はキーが必要です。 api-key は、検索サービスに対する要求を認証する一意のシステム生成文字列です。 検索サービスに対する要求を取得するには、(クエリ キーではなく) 管理キーに設定されたヘッダーを含める api-key 必要があります。 詳細については、「 キー認証を使用して Azure AI Search に接続 する」を参照してください。 |
要求本文
[なし] :
Response
状態コード: 正常に応答するために "200 OK" が返されます。 応答本文の形式は次のとおりです。
{
"counters": {
"documentCount": {
"usage": number,
"quota": number | null (if the service has unlimited document counts, the quota will be null)
},
"indexesCount": {
"usage": number,
"quota": number
},
"indexersCount": {
"usage": number,
"quota": number
},
"dataSourcesCount": {
"usage": number,
"quota": number
},
"storageSize": {
"usage": number (bytes),
"quota": number (bytes)
},
"synonymMaps": {
"usage": number,
"quota": number
},
"aliasesCount": {
"usage": number,
"quota": number
},
"vectorIndexSize": {
"usage": number (bytes),
"quota": number (bytes)
}
},
"limits": {
"maxFieldsPerIndex": number,
"maxIndexerRunTime": string,
"maxFileExtractionSize": number,
"maxFileContentCharactersToExtract": number,
"maxFieldNestingDepthPerIndex": number,
"maxComplexCollectionFieldsPerIndex": number,
"maxComplexObjectsInCollectionsPerDocument": number
}
}
| 統計 | 型 | 説明 |
|---|---|---|
| documentCount | Count | すべてのインデックスのすべてのドキュメントの集計。 Azure AI Search の初期バージョンではドキュメント数の制限が適用されましたが、その制限は存在しなくなりました。 クォータは、サービスが無制限のドキュメント数を持つ可能性があることを示す常に null です。 |
| indexesCount | Count | 検索サービスのインデックスの数。 最大インデックス数は、クォータによって報告されるレベルによって異なります。 |
| indexersCount | Count | 検索サービスのインデクサーの数。 最大インデクサーは、クォータによって報告されるレベルによって異なります。 |
| dataSourcesCount | Count | 検索サービス上のデータ ソースの数。 最大データ ソースは、クォータによって報告されるレベルによって異なります。 最大データ ソース数は、最大インデクサーと同じ数です。 |
| aliasesCount | Count | 検索サービスのインデックス エイリアスの数。 最大値は、クォータによって報告されるレベルによって異なります。 |
| synonymMaps | Count | 検索サービス上のシノニム マップの数。 最大値は、クォータによって報告されるレベルによって異なります。 |
| storageSize | バイト | 使用量は、サービス上のすべてのオブジェクトによって使用される容量ストレージです。 クォータは、サービス用に構成されたパーティションのサイズと数に基づいて使用可能な最大ストレージです。 検索サービスでプロビジョニングされたパーティションの数に応じて、クォータが増減します。 パーティションサイズは層によって異なります。 |
| vectorIndexSize | バイト | ベクター インデックスは内部構造であり、検索インデックスで定義されているベクター フィールドごとに 1 つのベクター インデックスです。 合計使用量はサービス全体で報告されるため、検索サービスのベクター インデックス制限に対するベクター空間の消費量を監視できます。 クォータは、階層によって決まる検索サービスの有効期間、パーティションの数、パーティションのサイズによって異なります。 |
すべての制限の詳細については、「 サービスの制限 」を参照してください。
例
この API はデータ プレーンです。 サービスのレベルや場所など、サービスの詳細については、 Management REST API に関するページを参照してください。
{
"@odata.context": "https://my-search-service.search.windows.net/$metadata#Microsoft.Azure.Search.V2019_05_06.ServiceStatistics",
"counters": {
"documentCount": {
"usage": 5072,
"quota": null
},
"indexesCount": {
"usage": 10,
"quota": 15
},
"indexersCount": {
"usage": 8,
"quota": 15
},
"dataSourcesCount": {
"usage": 9,
"quota": 15
},
"storageSize": {
"usage": 22265221,
"quota": 2147483648
},
"synonymMaps": {
"usage": 0,
"quota": 3
},
"aliasesCount": {
"usage": 7,
"quota": 30
},
"vectorIndexSize": {
"usage": 1342476,
"quota": 1073741824
},
"limits": {
"maxFieldsPerIndex": 1000,
"maxIndexerRunTime": "P1D",
"maxFileExtractionSize": 16777216,
"maxFileContentCharactersToExtract": 65536,
"maxFieldNestingDepthPerIndex": 10,
"maxComplexCollectionFieldsPerIndex": 40,
"maxComplexObjectsInCollectionsPerDocument": 3000
}
}