移動先

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

一般設定の取得

get

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

指定されたデータベースの一般設定を返します。expandパラメータを使用すると、その他の設定グループを拡張できます。expandがnoneの場合は、その他の設定グループへのリンクが返されます。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

問合せパラメータ

• expand: string

  一般設定のみと、グループ化されたその他の設定へのリンクを表示するには、noneを使用します。他には次の拡張オプションがあります。

  • startup (ブロック・ストレージ・キューブのみ)
  • calculation (ブロック・ストレージのみ)
  • buffers
  • caches (ブロック・ストレージのみ)
  • transactions (ブロック・ストレージのみ)
  • compression (集約ストレージのみ)
  • all

  デフォルト値: none

  指定可能な値: [ "none", "startup", "calculation", "buffers", "caches", "transactions", "compression", "all" ]

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

一般データベース設定が正常に返されました。拡張設定を取得するためのリンクが含まれています。

本体()

ルート・スキーマ : settings

型: object

ソースの表示

• buffers: object buffers
• caches: object caches
• calculation: object calculation
• compression: array compression
• general: object general
• links: array links
• startup: object startup
• transactions: object transactions

{
    "type":"object",
    "properties":{
        "general":{
            "$ref":"#/definitions/GeneralSettings"
        },
        "startup":{
            "$ref":"#/definitions/StartupSettings"
        },
        "calculation":{
            "$ref":"#/definitions/CalculationSettings"
        },
        "buffers":{
            "$ref":"#/definitions/BufferSettings"
        },
        "compression":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CompressionSettings"
            }
        },
        "caches":{
            "$ref":"#/definitions/CacheSettings"
        },
        "transactions":{
            "$ref":"#/definitions/TransactionSettings"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"settings"
    }
}

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

型: object

ソースの表示

• dataRetrievalBufferSize: integer(int64)

  取得リクエストごとに割り当てられる取得バッファ・サイズ

• dataRetrievalSortBufferSize: integer(int64)

  取得リクエストごとに割り当てられる取得ソート・バッファ・サイズ

{
    "type":"object",
    "properties":{
        "dataRetrievalBufferSize":{
            "type":"integer",
            "description":"<p>Retrieval buffer size allocated per retrieval request</p>",
            "format":"int64"
        },
        "dataRetrievalSortBufferSize":{
            "type":"integer",
            "description":"<p>Retrieval sort buffer size allocated per retrieval request</p>",
            "format":"int64"
        }
    },
    "xml":{
        "name":"buffers"
    }
}

ネストされたスキーマ : 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"
    }
}

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

型: object

ソースの表示

• aggregateMissingValues: boolean

  trueの場合は、通常のキューブ統合に伴い#MISSING値を集約します。デフォルトはfalseです(不足値は集約されない)。

• createBlocksOnEquations: boolean

  定数割当計算式でデータ・ブロックを強制的に作成します(疎ディメンションの場合のみ有効)。trueの場合は、ブロックが作成されます。

• twoPassCalculation: boolean

  完全計算の実行時に2パス計算が強制適用されます(2パス計算が有効になっている場合はtrue)

{
    "type":"object",
    "properties":{
        "aggregateMissingValues":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, aggregate #MISSING values along with the regular cube consolidation. The default is false (missing values are not aggregated).</p>"
        },
        "createBlocksOnEquations":{
            "type":"boolean",
            "description":"<p>Force creation of data blocks on constant assignment calc equations (only valid for sparse dimensions). If true, blocks are created.</p>"
        },
        "twoPassCalculation":{
            "type":"boolean",
            "description":"<p>Force two pass calculation when running a full calculation (<b>true</b> if two pass calculation is enabled)</p>"
        }
    },
    "xml":{
        "name":"calculation"
    }
}

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

型: array

ソースの表示

• 配列: object CompressionSettings

  様々なディメンションを圧縮ディメンションとして仮定で使用した、集約ストレージ・キューブの圧縮統計の推定値。これらの推定値は、最良の圧縮ディメンションを選択するために役立ちます。

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

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

型: object

ソースの表示

• description: string

  キューブの概要

• queryTracking: boolean

  問合せデータの収集が有効になっているかどうか。集約ストレージ・キューブのみに適用されます。trueの場合は、問合せトラッキングが有効になり、問合せベースのビューの最適化に使用できます。

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"<p>General description of the cube</p>"
        },
        "queryTracking":{
            "type":"boolean",
            "description":"<p>Whether collection of query data is enabled. Applies only to aggregate storage cubes. If <b>true</b>, query tracking is enabled, and can be used for query-based view optimization.</p>"
        }
    },
    "xml":{
        "name":"general"
    }
}

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

型: array

ソースの表示

• 配列: object Link

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

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

型: object

ソースの表示

• allowUsersToStartDatabase: boolean

  ユーザーにキューブの直接起動、またはキューブ起動が必要なリクエストの結果としての起動を可能または不可能にします。デフォルトはtrueです。

• startDatabaseWhenApplicationStarts: boolean

  アプリケーションの起動時にキューブを自動的に起動します。デフォルトはtrueです。allowUsersToStartDatabaseもtrueの場合のみ適用できます。

{
    "type":"object",
    "properties":{
        "allowUsersToStartDatabase":{
            "type":"boolean",
            "description":"<p>Enable or disable users from starting the cube, either directly, or as a result of requests requiring the cube to be started. The default is <b>true</b>.</p>"
        },
        "startDatabaseWhenApplicationStarts":{
            "type":"boolean",
            "description":"<p>Automatically start the cube when the application starts. The default is <b>true</b>. Applicable only when allowUsersToStartDatabase is also <b>true</b>.</p>"
        }
    },
    "xml":{
        "name":"startup"
    }
}

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

型: object

ソースの表示

• commitBlocks: integer(int64)

  明示的なコミットが実行される前(計算およびグリッド更新の間)に更新されたデータ・ブロックの数。committedAccessがfalseの場合に適用できます。

• commitRows: integer(int64)

  明示的なコミットが実行される前(データ・ロードの間)に処理された、入力ファイルの行の数。committedAccessがfalseの場合に適用できます。

• committedAccess: boolean

  trueの場合は、分離レベルをコミット済アクセスに設定します。つまり、一度に1つのトランザクションでのみデータ・ブロックを更新でき、Essbaseで、トランザクションおよびコミット操作が実行されるまですべてのデータ・ブロックに対する読取りロックおよび書込みロックが保持されます。その場合でも、concurrencyPreImageAccessが有効になっていれば、ユーザー(またはトランザクション)はその最後のコミット・ポイントでデータに読取り専用でアクセスできます。デフォルトはfalseです。

• concurrencyPreImageAccess: boolean

  trueの場合、キューブがコミット済モードなら、ユーザー(またはその他のトランザクション)は、その最後のコミット・ポイントでデータに読取り専用でアクセスできます(つまり、同時トランザクションの期間はデータ・ブロックがロックされる可能性がある)。committedAccessが有効になっている場合、デフォルトはtrueです。

• concurrencyWaitSeconds: integer(int32)

  ロック・タイムアウト間隔。データベースがコミット済モードの場合にブロックがロック解除されるまでの秒数。割り当てられた時間内に付与できないトランザクション・リクエストが行われた場合、トランザクションは、ロックを付与できるようになるまでロール・バックされます。committedAccessがtrueの場合のみ適用できます。

{
    "type":"object",
    "properties":{
        "committedAccess":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, sets the isolation level to committed access, meaning that only one transaction at a time can update data blocks, and Essbase holds read/write locks on all data blocks until the transaction and the commit operations are performed. If concurrencyPreImageAccess is enabled, users (or transactions) can still have read-only access to data at its last commit point. The default is <b>false</b>.</p>"
        },
        "concurrencyWaitSeconds":{
            "type":"integer",
            "description":"<p>Lock timeout interval; number of seconds to wait for blocks to be unlocked when the database is in committed mode. If a transaction request is made that cannot be granted in the allotted time, the transaction is rolled back until a lock can be granted. Applicable only when committedAccess is <b>true</b>.</p>",
            "format":"int32"
        },
        "concurrencyPreImageAccess":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, allow users (or other transactions) read-only access to data at its last commit point  when the cube is in committed mode (meaning that data blocks may be locked for the duration of a concurrent transaction). The default is <b>true</b>, when committedAccess is enabled.</p>"
        },
        "commitBlocks":{
            "type":"integer",
            "description":"<p>The number of data blocks updated before an explicit commit is performed (during calculation and grid updates). Applicable when committedAccess is <b>false</b>.</p>",
            "format":"int64"
        },
        "commitRows":{
            "type":"integer",
            "description":"<p>The number of rows of the input file processed before an explicit commit is performed (during data load). Applicable when committedAccess is <b>false</b>.</p>",
            "format":"int64"
        }
    },
    "xml":{
        "name":"transactions"
    }
}

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

型: object

様々なディメンションを圧縮ディメンションとして仮定で使用した、集約ストレージ・キューブの圧縮統計の推定値。これらの推定値は、最良の圧縮ディメンションを選択するために役立ちます。

ソースの表示

• averageBundleFill: number(double)

  集約ストレージ・キューブのみに適用されます。圧縮ディメンション・バンドル当たりの値の平均数の推定値。バンドル当たりの値の平均数が大きい圧縮ディメンションを選ぶほど、キューブの圧縮率が高くなります。

• averageValueLength: number(double)

  値の保管に必要なバイト数の平均の推定値。値保管に必要なバイト数の平均が小さいディメンションほど、キューブの圧縮率が高くなります。

• dimensionName: string

  圧縮統計を推定するために、集約ストレージの圧縮ディメンションであると仮定するディメンションの名前。

• isCompression: boolean

  集約ストレージの圧縮ディメンションであるかどうか。デフォルトでは、圧縮ディメンションは勘定科目ディメンションです。1つの集約ストレージ・キューブ内に存在できる圧縮ディメンションは1つのみです。

• level0MB: number(double)

  圧縮済キューブのサイズの推定値(MB単位)。レベル0サイズの推定値が小さいディメンションを選ぶほど、圧縮率が高くなります。圧縮ディメンションがない(「なし」)シナリオを除き、すべての推定値は、すべてのページが圧縮されることが前提となっています。圧縮されていないページと異なり、圧縮されているページにはさらにオーバーヘッドが必要になるため、一部のディメンションのレベル0データベース・サイズの推定値は、「なし」の値より大きくなる可能性があります。

• storedLevel0Members: number(double)

  保管されているレベル0メンバーの数。保管されているレベル0メンバーの数が多い集約ストレージ圧縮ディメンションは、適切に動作しません。動的に計算されるディメンションと同様で、一般的に、圧縮ディメンションからの上位レベルでの取得のほうが遅くなります。

{
    "type":"object",
    "description":"<p>Estimated compression statistics for an aggregate storage cube, with different dimensions hypothetically used as the compression dimension. These estimates can help you choose the best compression dimension.</p>",
    "properties":{
        "isCompression":{
            "type":"boolean",
            "description":"<p>Whether this is an aggregate storage compression dimension. By default, the compression dimension is the Accounts dimension. There can be only one compression dimension in an aggregate storage cube.</p>"
        },
        "storedLevel0Members":{
            "type":"number",
            "description":"<p>Number of stored level 0 members. Aggregate storage compression dimensions with a large number of stored level 0 members do not perform optimally. As with any dynamically calculated dimension, upper-level retrievals from compression dimensions generally are slower.</p>",
            "format":"double"
        },
        "averageBundleFill":{
            "type":"number",
            "description":"<p>Applies to aggregate storage cubes only. Estimated average number of values per compression dimension bundle. Choosing a compression dimension that has a higher average bundle fill means that the cube compresses better.</p>",
            "format":"double"
        },
        "averageValueLength":{
            "type":"number",
            "description":"<p>Estimated average number of bytes required to store a value. Dimensions with a smaller average value length compress the cube better.</p>",
            "format":"double"
        },
        "level0MB":{
            "type":"number",
            "description":"<p>Estimated size of the compressed cube, in megabytes. A smaller expected level-0 size indicates that choosing this dimension enables better compression. Except for the scenario in which there is no compression dimension (None), all estimates assume that all pages are compressed. Since compressed pages require additional overhead that uncompressed pages do not, the estimated level-0 database size for some dimensions may be larger than the value for None.</p>",
            "format":"double"
        },
        "dimensionName":{
            "type":"string",
            "description":"<p>Dimension name hypothetically considered to be the aggregate storage compression dimension, for purposes of estimating compression statistics.</p>"
        }
    }
}

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

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

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

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/databases/Basic/settings?expand=startup&links=none" -H "accept: application/json"-u %User%:%Password%

レスポンス本体の例

{
  "general": {
    "description": "",
    "queryTracking": false
  },
  "startup": {
    "allowUsersToStartDatabase": true,
    "startDatabaseWhenApplicationStarts": true
  },
  "links": [ ]
}

先頭に戻る