移動先

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

実行時統計の取得

get

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

指定されたデータベースの実行時統計を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

データベースの実行時統計が正常に返されました。

本体()

ルート・スキーマ : RuntimeStatistics

型: object

ソースの表示

• cacheHitRatio: number(double)

  ハード・ディスクからではなく、集約ストレージ・キャッシュから回答があったリクエストの数の割合。並列データ・ロードまたは並列計算操作を実行しているときは正確でなくなる可能性があります。

• currentCacheSize: number(double)

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

• currentCacheSizeLimit: number(double)

  集約ストレージ・キャッシュを拡大可能な最大サイズ(KB単位)。

• diskSpaceAllocatedForData: number(double)

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

• diskSpaceUsedByData: number(double)

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

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

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

• pageSize: number(double)

  集約ストレージ・キューブの場合は、データ・ページのサイズ(KB単位)。

• pageWritesSinceLastStartup: number(double)

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

• temporaryDiskSpaceAllocated: number(double)

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

• temporaryDiskSpaceUsed: number(double)

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

{
    "type":"object",
    "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"
        }
    }
}

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/runtime" -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

{
  "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
  }
}

先頭に戻る