機械翻訳について

ジャンプ先

• 要求
• レスポンス
• 例

一般統計の取得

get

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

指定されたデータベースの一般統計を戻します。 expandパラメータを使用して、追加の統計を取得できます。

要求

パス・パラメータ

• applicationName: string

  アプリケーション名

• databaseName: string

  データベース名

問合せパラメータ

• expand(optional): string

  noneを使用して、一般統計のみを表示します(これがデフォルトです)。 その他の使用可能なオプション: storage、runtimeおよびall。

  デフォルト値: none

  許可される値: [ "none", "storage", "runtime", "all" ]

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

一般的なデータベース統計が、拡張統計を取得するためのリンクとともに正常に返されました。

本文()

ルート・スキーマ : statistics

タイプ: object

Show Source

• general(optional): object GeneralStatistics
• links(optional): array links
• runtime(optional): object RuntimeStatistics

  アプリケーションのランタイム・ストレージ統計

• storage(optional): object StorageStatistics

{
    "type":"object",
    "properties":{
        "general":{
            "$ref":"#/definitions/GeneralStatistics"
        },
        "storage":{
            "$ref":"#/definitions/StorageStatistics"
        },
        "runtime":{
            "$ref":"#/definitions/RuntimeStatistics"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"statistics"
    }
}

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

タイプ: object

Show Source

• databaseElapsedTime(optional): string
• databaseStartTime(optional): integer(int64)
• loadStatus(optional): string
• numberOfConnections(optional): integer(int32)
• numberOfDimensions(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "databaseStartTime":{
            "type":"integer",
            "format":"int64"
        },
        "databaseElapsedTime":{
            "type":"string"
        },
        "numberOfConnections":{
            "type":"integer",
            "format":"int32"
        },
        "numberOfDimensions":{
            "type":"integer",
            "format":"int32"
        },
        "loadStatus":{
            "type":"string"
        }
    }
}

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

タイプ: array

Show Source

• Array of: object Link

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

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

タイプ: object

アプリケーションのランタイム・ストレージ統計

Show Source

• cacheHitRatio(optional): number(double)

  ハード・ディスクからではなく、集約ストレージ・キャッシュから応答されたリクエスト数の比率。 パラレル・データ・ロードまたはパラレル計算操作が使用されている場合、正確でない可能性があります。

• currentCacheSize(optional): number(double)

  集約ストレージ・キャッシュの現在のサイズ。 currentCacheSizeLimitも参照してください。

• currentCacheSizeLimit(optional): number(double)

  集約ストレージ・キャッシュの最大サイズ(キロバイト)。

• diskSpaceAllocatedForData(optional): number(double)

  集約ストレージ・キューブの場合、デフォルト表領域のすべてのディスク・ファイルで使用される合計領域。

• diskSpaceUsedByData(optional): number(double)

  集約ストレージ・キューブの場合、デフォルト表領域のディスク・ファイル内で実際に使用されている合計領域(ファイル内の一部の領域は空いている可能性があります)。

• hitRatioOnDataCache(optional): number(double)
• hitRatioOnDataFileCache(optional): number(double)
• hitRatioOnIndexCache(optional): number(double)
• numberOfDataBlockReads(optional): number(double)
• numberOfDataBlockWrites(optional): number(double)
• numberOfIndexPageReads(optional): number(double)
• numberOfIndexPageWrites(optional): number(double)
• pageReadsSinceLastStartup(optional): number(double)

  集約ストレージ・キューブの場合、アプリケーションが最後に起動されてからディスクから読み取られたデータ・ページの数。

• pageSize(optional): number(double)

  集約ストレージ・キューブの場合、データ・ページのサイズ(メガバイト)。

• pageWritesSinceLastStartup(optional): number(double)

  集約ストレージ・キューブの場合、アプリケーションが最後に起動されてからディスクに書き込まれたデータ・ページの数。

• temporaryDiskSpaceAllocated(optional): number(double)

  集約ストレージ・キューブの場合、一時表領域内のすべてのディスク・ファイルによって使用される合計領域。

• temporaryDiskSpaceUsed(optional): number(double)

  集約ストレージ・キューブの場合、一時表領域のディスク・ファイル内で実際に使用されている合計領域(ファイル内の一部の領域は空いている可能性があります)。

{
    "type":"object",
    "description":"<p>Runtime storage statistics for an application</p>",
    "properties":{
        "cacheHitRatio":{
            "type":"number",
            "description":"<p>Ratio of the number of requests answered from aggregate storage cache as opposed to from the hard disk. May not be accurate when parallel data load or parallel calculation operations are in use.</p>",
            "format":"double"
        },
        "currentCacheSize":{
            "type":"number",
            "description":"<p>The current size of the aggregate storage cache. See also currentCacheSizeLimit.</p>",
            "format":"double"
        },
        "currentCacheSizeLimit":{
            "type":"number",
            "description":"<p>The maximum size (in kilobytes) to which the aggregate storage cache may grow.</p>",
            "format":"double"
        },
        "pageReadsSinceLastStartup":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, number of data pages read from disk since the last time the application was started.</p>",
            "format":"double"
        },
        "pageWritesSinceLastStartup":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, number of data pages written to disk since the last time the application was started.</p>",
            "format":"double"
        },
        "pageSize":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, size of the data page in kilobytes.</p>",
            "format":"double"
        },
        "diskSpaceAllocatedForData":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, total space used by all disk files in the default tablespace.</p>",
            "format":"double"
        },
        "diskSpaceUsedByData":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, total space actually in use within the disk files in the default tablespace (some space within files may be free).</p>",
            "format":"double"
        },
        "temporaryDiskSpaceAllocated":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, total space used by all disk files in the temp tablespace.</p>",
            "format":"double"
        },
        "temporaryDiskSpaceUsed":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, total space actually in use within the disk files in the temp tablespace (some space within files may be free).</p>",
            "format":"double"
        },
        "hitRatioOnIndexCache":{
            "type":"number",
            "format":"double"
        },
        "hitRatioOnDataCache":{
            "type":"number",
            "format":"double"
        },
        "numberOfIndexPageReads":{
            "type":"number",
            "format":"double"
        },
        "numberOfIndexPageWrites":{
            "type":"number",
            "format":"double"
        },
        "numberOfDataBlockReads":{
            "type":"number",
            "format":"double"
        },
        "numberOfDataBlockWrites":{
            "type":"number",
            "format":"double"
        },
        "hitRatioOnDataFileCache":{
            "type":"number",
            "format":"double"
        }
    }
}

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

タイプ: object

Show Source

• aggregateDataSize(optional): integer(int32)

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

• averageClusteringRatio(optional): number(double)

  ページ・ファイルの断片化の測定。 1に近い値は、断片化の程度が低いことを示します。 ゼロに近い値は、計算および問合せのパフォーマンスに影響を与える可能性がある高度な断片化を示します。

• blockDensity(optional): number(double)

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

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

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

• costOfQueryingIncrementalData(optional): number(double)

  集約ストレージ・キューブの場合、増分データ・スライスの処理に費やされた問合せ時間の平均割合。 これは、スライスをマージして問合せのパフォーマンスを向上させるタイミングを決定する場合に役立ちます。

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

  キューブ内の欠落していないリーフ(最下位レベル)ブロックの数

• existingUpperLevelBlocks(optional): number(double)

  キューブ内の欠落していない非リーフ(上位レベル)ブロックの数

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

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

• maxKeyLengthBits(optional): integer(int32)

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

• maxKeyLengthBytes(optional): integer(int32)

  集約ストレージ・キューブの場合、キーがセル当たりに使用するバイト数

• numberOfAggregateCells(optional): integer(int32)

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

• numberOfAggregateViews(optional): integer(int32)

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

• numberOfExistingBlocks(optional): number(double)

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

• numberOfIncrementalAggregateCells(optional): integer(int32)

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

• numberOfIncrementalDataSlices(optional): integer(int32)

  集約ストレージ・キューブの場合、増分データ・ロードによって発生するデータ・スライスの数

• numberOfIncrementalInputCells(optional): integer(int32)

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

• numberOfInputLevelCells(optional): integer(int32)

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

• pageFileSize(optional): integer(int64)
• percentageOfMaximumBlocksExisting(optional): number(double)
• potentialNumberOfBlocks(optional): 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"
        }
    }
}

ネストされたスキーマ : リンク

タイプ: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

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

タイプ: array

Show Source

• Array of: object StatisticsDimensions

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

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

タイプ: object

Show Source

• bits(optional): number(double)
• levels(optional): string
• name(optional): 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://192.0.2.1:443/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/statistics?expand=all"
     -H  "accept: application/json"
     -u %User%:%Password

レスポンス本体の例

{
  "general": {
    "databaseStartTime": 1586308012000,
    "databaseElapsedTime": "0:0:3:34",
    "numberOfConnections": 1,
    "numberOfDimensions": 10,
    "loadStatus": "Loaded"
  },
  "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
  },
  "runtime": {
    "cacheHitRatio": 0,
    "currentCacheSize": 0,
    "currentCacheSizeLimit": 0,
    "pageReadsSinceLastStartup": 0,
    "pageWritesSinceLastStartup": 0,
    "pageSize": 0,
    "diskSpaceAllocatedForData": 0,
    "diskSpaceUsedByData": 0,
    "temporaryDiskSpaceAllocated": 0,
    "temporaryDiskSpaceUsed": 0,
    "hitRatioOnIndexCache": 0,
    "hitRatioOnDataCache": 0,
    "numberOfIndexPageReads": 0,
    "numberOfIndexPageWrites": 0,
    "numberOfDataBlockReads": 0,
    "numberOfDataBlockWrites": 0,
    "hitRatioOnDataFileCache": 0
  }
}

先頭に戻る