サービス統計情報の取得 (プレビュー REST API)

  • [アーティクル]

: 2023-07-01-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 必須。 その他のバージョンについては、API のバージョン を参照してください。

要求ヘッダー

次の表では、必須の要求ヘッダーと省略可能な要求ヘッダーについて説明します。

田畑 形容
Content-Type 必須。 この値を application/json に設定します
api-key Azure ロール 使用していて、要求にベアラー トークンが提供されている場合は省略可能。それ以外の場合はキーが必要です。 API キーは、検索サービスに対する要求を認証する一意のシステム生成文字列です。 検索サービスに対する要求を取得するには、(クエリ キーではなく) 管理者キーに設定された api-key ヘッダーを含める必要があります。 詳細については、「キー認証 を使用して Azure AI Search に接続する」を参照してください。

要求本文

何一つ。

応答

状態コード: "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 数える すべてのインデックスのすべてのドキュメントの集計。 Azure AI Search の初期バージョンではドキュメント数の制限が適用されていますが、その制限は存在しなくなりました。 クォータは、サービスが無制限のドキュメント数を持つことができることを示す常に null です。
indexesCount 数える 検索サービスのインデックスの数。 最大インデックス数は、クォータによって報告されるレベルによって異なります。
indexersCount 数える 検索サービスのインデクサーの数。 最大インデクサーは、クォータによって報告されるレベルによって異なります。
dataSourcesCount 数える 検索サービス上のデータ ソースの数。 最大データ ソースは、クォータによって報告されるレベルによって異なります。 最大データ ソースは、最大インデクサーと同じ数です。
aliasesCount 数える 検索サービスのインデックス エイリアスの数。 最大値は、クォータによって報告されるレベルによって異なります。
synonymMaps 数える 検索サービス上のシノニム マップの数。 最大値は、クォータによって報告されるレベルによって異なります。
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
    }
}

関連項目