移動先

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

バッファ設定の取得

get

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

指定されたデータベースのバッファ設定を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

バッファの設定を正常に取得しました。

本体()

ルート・スキーマ : 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"
    }
}

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

レスポンス本体の例

{
  "buffers": {
    "dataRetrievalBufferSize": 20480,
    "dataRetrievalSortBufferSize": 20480
  }
}

先頭に戻る