移動先

• リクエスト
• レスポンス
• 例

ストレージ統計の取得

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/statistics/storage

指定されたデータベースのストレージ統計を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json
• application/xml

200 レスポンス

OK

データベースのストレージ統計が正常に返されました。

本体()

ルート・スキーマ : StorageStatistics

型: object

ソースの表示

• aggregateDataSize: integer(int32)

  集約ストレージ・キューブの場合は、集約セルによって占有されているディスク・スペースの合計。

• averageClusteringRatio: number(double)

  ページ・ファイルの断片化の程度。1に近い値を指定すると、断片化の度合いが低くなります。0に近い値を指定すると、断片化の度合いが高くなり、計算および問合せのパフォーマンスに影響する可能性があります。

• blockDensity: number(double)

  平均ブロック密度(現在ロードされているすべてのブロックを使用して計算される)

• blockSize: integer(int32)
• compressionRatio: number(double)

  平均データ・ブロック圧縮率

• costOfQueryingIncrementalData: number(double)

  集約ストレージ・キューブの場合は、増分データ・スライスの処理に費やした問合せ時間の割合の平均。これは、問合せパフォーマンスの向上のために複数のスライスをマージする必要があるかどうかの判断に役立ちます。

• dimensions: array dimensions
• existingLevelZeroBlocks: number(double)

  キューブ内の非欠落リーフ(最下位レベル)ブロックの数。

• existingUpperLevelBlocks: number(double)

  キューブ内の非欠落かつ非リーフ(上位レベル)のブロックの数。

• indexFileSize: integer(int64)
• inputLevelDataSize: integer(int32)

  集約ストレージ・キューブの場合は、入力レベルのデータによって使用されているディスク・スペースの合計。

• maxKeyLengthBits: integer(int32)

  集約ストレージ・キューブの場合は、各ディメンションによって使用されているすべてのビットの合計。たとえば、ディメンションに使用されているキーは20ビットであり、最初の4ビットはYearによって使用されています。

• maxKeyLengthBytes: integer(int32)

  集約ストレージ・キューブの場合は、セル当たりの、キーで使用されるバイトの数

• numberOfAggregateCells: integer(int32)

  集約ストレージ・キューブの場合は、集約ビューに格納されるセルの数

• numberOfAggregateViews: integer(int32)

  集約ストレージ・キューブの場合は、集約ビューの数(増分スライス上に自動的に構築されたものを含む)

• numberOfExistingBlocks: number(double)

  既存のデータ・ブロックの合計数(最大数ではない)

• numberOfIncrementalAggregateCells: integer(int32)

  集約ストレージ・キューブの場合は、増分スライスの集約ビューに格納されるセルの数

• numberOfIncrementalDataSlices: integer(int32)

  集約ストレージ・キューブの場合は、増分データ・ロードからもたらされるデータ・スライスの数

• numberOfIncrementalInputCells: integer(int32)

  集約ストレージ・キューブの場合は、増分データ・スライス内のレベル0セルの数

• numberOfInputLevelCells: integer(int32)

  集約ストレージ・キューブの場合は、データベース内の既存のレベル0セルの数(増分スライスを含む)

• pageFileSize: integer(int64)
• percentageOfMaximumBlocksExisting: number(double)
• potentialNumberOfBlocks: number(double)

{
    "type":"object",
    "properties":{
        "dimensions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StatisticsDimensions"
            }
        },
        "maxKeyLengthBits":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the sum of all the bits used by each dimension. For example, there are 20 bits in the key used for dimensions, and the first 4 are used by Year.</p>",
            "format":"int32"
        },
        "maxKeyLengthBytes":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, how many bytes the key uses per cell</p>",
            "format":"int32"
        },
        "numberOfInputLevelCells":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of existing level-0 cells in the database, including incremental slices</p>",
            "format":"int32"
        },
        "numberOfIncrementalDataSlices":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of data slices resulting from incremental data loads</p>",
            "format":"int32"
        },
        "numberOfIncrementalInputCells":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of level-0 cells in the incremental data slices</p>",
            "format":"int32"
        },
        "numberOfAggregateViews":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of aggregate views, including those automatically built on incremental slices</p>",
            "format":"int32"
        },
        "numberOfAggregateCells":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of cells stored in aggregate views</p>",
            "format":"int32"
        },
        "numberOfIncrementalAggregateCells":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of cells stored in the incremental slices' aggregate views</p>",
            "format":"int32"
        },
        "costOfQueryingIncrementalData":{
            "type":"number",
            "description":"<p>For aggregate storage cubes, the average percentage of query time spent processing incremental data slices. This is useful in deciding when slices should be merged together to improve query performance.</p>",
            "format":"double"
        },
        "inputLevelDataSize":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the total disk space used by input-level data</p>",
            "format":"int32"
        },
        "aggregateDataSize":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the total disk space occupied by aggregate cells</p>",
            "format":"int32"
        },
        "numberOfExistingBlocks":{
            "type":"number",
            "description":"<p>Total number of existing data blocks (not the maximum)</p>",
            "format":"double"
        },
        "blockSize":{
            "type":"integer",
            "format":"int32"
        },
        "potentialNumberOfBlocks":{
            "type":"number",
            "format":"double"
        },
        "existingLevelZeroBlocks":{
            "type":"number",
            "description":"<p>The number of non-missing leaf (lowest level) blocks in the cube</p>",
            "format":"double"
        },
        "existingUpperLevelBlocks":{
            "type":"number",
            "description":"<p>The number of non-missing, non-leaf (upper level) blocks in the cube</p>",
            "format":"double"
        },
        "blockDensity":{
            "type":"number",
            "description":"<p>The average block density (calculated using all currently loaded blocks)</p>",
            "format":"double"
        },
        "percentageOfMaximumBlocksExisting":{
            "type":"number",
            "format":"double"
        },
        "compressionRatio":{
            "type":"number",
            "description":"<p>Average data block compression ratio</p>",
            "format":"double"
        },
        "averageClusteringRatio":{
            "type":"number",
            "description":"<p>A measure of the fragmentation of the page file. A value close to 1 indicates the degree of fragmentation is low. A value close to zero indicates a high degree of fragmentation that could affect calculation and query performance.</p>",
            "format":"double"
        },
        "pageFileSize":{
            "type":"integer",
            "format":"int64"
        },
        "indexFileSize":{
            "type":"integer",
            "format":"int64"
        }
    }
}

ネストされたスキーマ : dimensions

型: array

ソースの表示

• 配列: object StatisticsDimensions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StatisticsDimensions"
    }
}

ネストされたスキーマ : StatisticsDimensions

型: object

ソースの表示

• bits: number(double)
• levels: string
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "levels":{
            "type":"string"
        },
        "bits":{
            "type":"number",
            "format":"double"
        }
    }
}

400 レスポンス

不正なリクエスト

ストレージ統計の取得に失敗しました。アプリケーション名またはデータベース名が正しくない可能性があります。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、キューブのストレージ統計を取得する方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/statistics/storage" -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "storage": {
    "maxKeyLengthBits": 0,
    "maxKeyLengthBytes": 0,
    "numberOfInputLevelCells": 0,
    "numberOfIncrementalDataSlices": 0,
    "numberOfIncrementalInputCells": 0,
    "numberOfAggregateViews": 0,
    "numberOfAggregateCells": 0,
    "numberOfIncrementalAggregateCells": 0,
    "costOfQueryingIncrementalData": 0,
    "inputLevelDataSize": 0,
    "aggregateDataSize": 0,
    "numberOfExistingBlocks": 354,
    "blockSize": 672,
    "potentialNumberOfBlocks": 1900,
    "existingLevelZeroBlocks": 354,
    "existingUpperLevelBlocks": 0,
    "blockDensity": 83.61904761904762,
    "percentageOfMaximumBlocksExisting": 18.63157894736842,
    "compressionRatio": 0.9943010752688172,
    "averageClusteringRatio": 0.33334593787222777,
    "pageFileSize": 294969,
    "indexFileSize": 8216576
  }
}

先頭に戻る