機械翻訳について

ジャンプ先

• 要求
• レスポンス
• 例

起動設定の取得

get

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

指定されたデータベースの起動設定を返します。

要求

パス・パラメータ

• applicationName: string

  アプリケーション名

• databaseName: string

  データベース名

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

起動設定が正常に返されました。

本文()

ルート・スキーマ : startup

タイプ: object

Show Source

• allowUsersToStartDatabase(optional): boolean

  直接、またはキューブの起動を必要とするリクエストの結果として、ユーザーによるキューブの起動を有効または無効にします。 デフォルトはtrueです。

• startDatabaseWhenApplicationStarts(optional): 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"
    }
}

400 レスポンス

不正なリクエスト

起動設定の返却に失敗しました。 アプリケーション名またはデータベース名が正しくない可能性があります。

500 レスポンス

内部サーバー・エラー。

先頭に戻る

例

次の例は、cURLを使用してWindowsシェル・スクリプトからREST APIにアクセスし、キューブの現在の起動設定を取得する方法を示しています。

コール元のユーザーIDおよびパスワードは、properties.batで値が設定される変数です。

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

call properties.bat
curl -X GET "https://192.0.2.1:443/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/settings/startup"
     -H  "accept: application/json"
     -u %User%:%Password

レスポンス本体の例

{
  "startup": {
    "allowUsersToStartDatabase": true,
    "startDatabaseWhenApplicationStarts": true
  }
}

先頭に戻る