Oracle Essbase REST API

バッファのリスト

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/asodataload/buffers

集約ストレージの既存のデータ・ロード・バッファをリストします。ブロック・ストレージ・データベース上で呼び出された場合は、エラーが返されます。

リクエスト

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

application/json
application/xml

パス・パラメータ

applicationName(required): string

アプリケーション名。
databaseName(required): string

データベース名。

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

ロード・バッファのリストが正常に返されました。

ルート・スキーマ : LoadBuffersList

型: object

ソースの表示

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

使用可能なその他のプロパティ: additionalProperties
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataLoadBuffer"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: array

ソースの表示

配列: object DataLoadBuffer

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

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

型: object

使用可能なその他のプロパティ

ソースの表示

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

型: object

ソースの表示

bufferId: integer(int64)

単一の集約ストレージ・データ・ロード・バッファの一意のID。1から4294967296の間の数値である必要があります。
duplicateAggregationMethod: string
指定可能な値: [ "ADD", "ASSUME_EQUAL", "USE_LAST" ]
集約ストレージ・データ・ロード・バッファ内の、重複セルのセル競合を解決するオプションを選択します。
- ADD: (デフォルト)バッファの同じセルに複数の値が含まれる場合に値を加算します。
- ASSUME_EQUAL: 重複する値を等しいものとして扱います。
- USE_LAST: 最後にデータ・ロード・バッファにロードされたセルの値を使用して、重複セルを結合します。
loadBufferOptions: string
指定可能な値: [ "IGNORE_NONE", "IGNORE_MISSING_VALUES", "IGNORE_ZERO_VALUES", "IGNORE_MISSING_AND_ZERO_VALUES" ]
オプションを選択して、集約ストレージ・データ・ロード・バッファ内の欠落値と0値を処理する方法を決定します。
- IGNORE_NONE(0): 入力データ・ストリームの値を無視しません
- IGNORE_MISSING_VALUES(1): 入力データ・ストリームの#MI値を無視します
- IGNORE_ZERO_VALUES(2): 入力データ・ストリームの0値を無視します
- IGNORE_MISSING_AND_ZERO_VALUES(3): 入力データ・ストリームの#MI値と0値を無視します
resourceUsage: integer(int64)

ロード・バッファに使用が許可される合計ロード・バッファ・リソースのパーセンテージは、[0, 100]の範囲内である必要があり、その値が0の場合はデフォルト(現在は100)と解釈されます。

{
    "type":"object",
    "properties":{
        "bufferId":{
            "type":"integer",
            "description":"<p>Unique ID of a single aggregate storage data load buffer. Must be a number between 1 and 4294967296.</p>",
            "format":"int64"
        },
        "duplicateAggregationMethod":{
            "type":"string",
            "description":"<p>Select an option to resolve cell conflicts for duplicate cells in the aggregate storage data load buffer.</p><ul><li><code>ADD</code>: (Default) Add values when the buffer contains multiple values for the same cell.</li><li><code>ASSUME_EQUAL</code>: Treat duplicate values as equal. </li><li><code>USE_LAST</code>: Combine duplicate cells by using the value of the cell that was loaded last into the data load buffer.</li></ul>",
            "enum":[
                "ADD",
                "ASSUME_EQUAL",
                "USE_LAST"
            ]
        },
        "loadBufferOptions":{
            "type":"string",
            "description":"<p>Select an option to determine how missing and zero values in the aggregate storage data load buffer should be handled.</p> <ul><li><code>IGNORE_NONE(0)</code>: Do not ignore any values in the incoming data stream</li><li><code>IGNORE_MISSING_VALUES(1)</code>: Ignore #MI values in the incoming data stream</li><li><code>IGNORE_ZERO_VALUES(2)</code>: Ignore zero values in the incoming data stream</li><li><code>IGNORE_MISSING_AND_ZERO_VALUES(3)</code>: Ignore #MI and zero values in the incoming data stream</li></ul>",
            "enum":[
                "IGNORE_NONE",
                "IGNORE_MISSING_VALUES",
                "IGNORE_ZERO_VALUES",
                "IGNORE_MISSING_AND_ZERO_VALUES"
            ]
        },
        "resourceUsage":{
            "type":"integer",
            "format":"int64",
            "description":"<p>Percentage of the total load buffer resources that the load buffer will be allowed to use; must be within [0, 100], and the value of 0 is interpreted as default, which is currently 100.</p>"
        }
    }
}

400 レスポンス

不正なリクエスト

ロード・バッファの取得に失敗しました。

500 レスポンス

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

先頭に戻る

例

集約ストレージ・キューブにより、最大100万以上のメンバーを含む非常に大規模なディメンションの分析が容易になります。このような大きなキューブへの、効率的なデータ値の増分ロードをサポートするためにEssbaseで可能なことを次に示します。

一時集約ストレージ・データ・ロード・バッファを介して、複数のデータソースを処理できます
データ・ロード・バッファで使用するリソースの割合を制御できます
集約ストレージ・データベースにデータの複数のスライスを含めることができます(データベースに対する問合せが各スライスにアクセスして、すべてのデータ・セルを収集します)
データのサイズに比例した時間で増分ロード・プロセスを完了します。

大きなキューブへのデータの増分ロードをサポートするために、集約ストレージ・キューブで複数のデータ・ロード・バッファを初期化できます。このREST APIでは、既存の各データ・ロード・バッファに関する次の情報が戻されます。

bufferId -- データ・ロード・バッファのID (1から4294967296の間の数値)。
duplicateAggregationMethod -- 同じセルの複数の値がバッファ内のデータ・ストリームからロードされている場合の処理に使用される方法の1つ。
- ADD -- バッファに同じセルの複数の値が含まれる場合に値を加算します。
- ASSUME_EQUAL -- 値が等しくない重複がある場合にロードを停止します。
- USE_LAST -- 最後にロード・バッファにロードされたセルの値を使用して、重複セルを結合します。これは、無効な集計を排除するためにテキスト値と日付値をロードする場合に、最も適した選択肢です。
loadBufferOptions -- ロード中に欠落値と0値を処理する方法。
- IGNORE_NONE -- 入力データ・ストリームの#MISSING値と0値のいずれも無視しません。このオプションを選択するには、このキーワードまたは0を渡します。
- IGNORE_MISSING_VALUES -- 入力データ・ストリームの#MISSING値を無視します。このオプションを選択するには、このキーワードまたは1を渡します。
- IGNORE_ZERO_VALUES -- 入力データ・ストリームの0を無視しますこのオプションを選択するには、このキーワードまたは2を渡します。
- IGNORE_MISSING_AND_ZERO_VALUES -- 入力データ・ストリームの0値と#MISSING値を無視します。このオプションを選択するには、このキーワードまたは3を渡します。
resourceUsage -- ロード・バッファが使用できる合計ロード・バッファ・リソースのパーセンテージ。[0, 100]の範囲に収まる必要があります。デフォルトは100、0はデフォルトとして解釈されます。

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

次の例に、現在初期化されている集約ストレージ・データ・ロード・バッファをリストする方法を示します。

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

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

レスポンス本文

{
  "items": [
    {
      "bufferId": 100,
      "duplicateAggregationMethod": "ADD",
      "loadBufferOptions": "IGNORE_MISSING_VALUES",
      "resourceUsage": 50
    },
    {
      "bufferId": 200,
      "duplicateAggregationMethod": "ADD",
      "loadBufferOptions": "IGNORE_MISSING_VALUES",
      "resourceUsage": 50
    }
  ],
  "totalResults": 2
}

先頭に戻る