移動先

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

キャッシュ設定の取得

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings/caches

指定されたデータベースのキャッシュ設定を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

キャッシュの設定が正常に返されました。

本体()

ルート・スキーマ : caches

型: object

ソースの表示

• cacheMemoryLocking: boolean

  直接I/Oと同様に、非推奨

• dataCacheCurrentValue: integer(int64)

  データ・キャッシュの実行時サイズ(KB単位)

• dataCacheSetting: integer(int64)

  現在有効なデータ・キャッシュ・サイズ設定値(KB単位)

• dataFileCacheCurrentValue: integer(int64)

  現在キューブによって使用されている実行時データ・ファイル・キャッシュ・サイズ(KB単位)。データ・ファイル・キャッシュ・サイズを変更した場合は、新しいデータ・ファイル・キャッシュ・サイズを有効にするために、キューブを停止してから再起動する必要があります。

• dataFileCacheSetting: integer(int64)

  現在有効なデータ・ファイル・キャッシュ・サイズ設定値

• indexCacheCurrentValue: integer(int64)

  インデックス・キャッシュの実行時サイズ(KB単位)

• indexCacheSetting: integer(int64)

  現在有効なインデックス・キャッシュ・サイズ(KB単位)設定値

• indexPageCurrentValue: integer(int32)

  インデックス・ページの実行時サイズ(KB単位)

• indexPageSetting: integer(int32)

  現在有効なインデックス・ページ・サイズ設定(KB単位)

{
    "type":"object",
    "properties":{
        "cacheMemoryLocking":{
            "type":"boolean",
            "description":"<p>Deprecated, along with direct I/O</p>"
        },
        "indexCacheSetting":{
            "type":"integer",
            "description":"<p>The index cache size (in KB) setting value currently in effect</p>",
            "format":"int64"
        },
        "indexCacheCurrentValue":{
            "type":"integer",
            "description":"<p>Run-time size (in KB) of the index cache</p>",
            "format":"int64"
        },
        "dataFileCacheSetting":{
            "type":"integer",
            "description":"<p>The data file cache size setting value currently in effect</p>",
            "format":"int64"
        },
        "dataFileCacheCurrentValue":{
            "type":"integer",
            "description":"<p>The run-time data file cache size (in KB) currently in use by the cube. Once you have changed the data file cache size, you must stop and restart the cube in order for the new data file cache size to take effect.</p>",
            "format":"int64"
        },
        "dataCacheSetting":{
            "type":"integer",
            "description":"<p>The data cache size setting value (in KB) currently in effect</p>",
            "format":"int64"
        },
        "dataCacheCurrentValue":{
            "type":"integer",
            "description":"<p>The run-time size (in KB) of the data cache</p>",
            "format":"int64"
        },
        "indexPageSetting":{
            "type":"integer",
            "description":"<p>The index page size setting (in KB) currently in effect</p>",
            "format":"int32"
        },
        "indexPageCurrentValue":{
            "type":"integer",
            "description":"<p>Run-time size (in KB) of an index page</p>",
            "format":"int32"
        }
    },
    "xml":{
        "name":"caches"
    }
}

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

レスポンス本体の例

{
  "caches": {
    "cacheMemoryLocking": false,
    "indexCacheSetting": 1048576,
    "indexCacheCurrentValue": 1048576,
    "dataFileCacheSetting": 33554432,
    "dataFileCacheCurrentValue": 0,
    "dataCacheSetting": 3145728,
    "dataCacheCurrentValue": 0,
    "indexPageSetting": 8192,
    "indexPageCurrentValue": 8192
  }
}

先頭に戻る