アプリケーション接続の更新
/essbase/rest/v1/applications/{applicationName}/connections/{connectionName}
指定されたアプリケーション接続を更新します。成功した場合は、更新後の接続の詳細を返します。typeはすべての接続に必須の入力内容です。必要なその他の入力内容は、接続のタイプによって異なります。
リクエスト
- application/json
- application/xml
- applicationName(required): string
アプリケーション名。
- connectionName(required): string
接続名。
接続の詳細。
object- catalog: boolean
- datasource: string
- dbDriver: string
オプション。typeが
DBである場合に、汎用JDBCドライバを使用するようにEssbaseを構成するには、JDBCドライバの完全修飾クラス名を指定します。oracle.jdbc.driver.OracleDriverなどです。 - dbURL: string
外部RDBMSデータベースへのURLまたはEssbaseインスタンスへの検出URL。他のEssbaseインスタンスへの接続の場合、このパラメータはhostおよびportを指定するかわりになります。Essbase検出URLの例:
https://192.0.2.1:443/essbase/agent。他の使用方法の例は、グローバルな「接続の取得」エンドポイントのドキュメントを参照してください。 - description: string
この接続の説明文字列。
- encrypted: boolean
- host: string
ホスト・サーバー名またはIP。Oracle Database接続の場合、必須です。Essbase接続の場合、かわりにdbURLを使用しないかぎり、必須です。
- links: array links
- maxPoolSize: integer(int32)
最大接続プール・サイズ。デフォルトは50です。接続エラーが発生した場合、最小および最大接続プール・サイズの調整が必要になることがあります。Universal Connection Pool開発者ガイドのUCPでのプール・サイズの制御についてを参照してください。
- minPoolSize: integer(int32)
最小接続プール・サイズ。デフォルトは5です。接続エラーが発生した場合、最小および最大接続プール・サイズの調整が必要になることがあります。Universal Connection Pool開発者ガイドのUCPでのプール・サイズの制御についてを参照してください。
- name(required): string
この接続の名前。
- password: string
必須。この接続のリモート・ソースへのアクセスを認可されているユーザーIDのパスワード。
- path: string
ファイル・タイプ接続の場合、必須です。データのファイル・ソースへのカタログ・パス。例: /gallery/Technical/Drill Through/DrillthroughDS.csv
- port: integer(int32)
リモート・ホストのポート番号。hostが指定されているときの接続の場合、必須です。
- repoWallet: boolean
すでに使用可能なAutonomous Data Warehouse接続(リポジトリ接続)を使用している場合、trueに設定します。その場合、ウォレットをアップロードする必要はありません。
- schema: string
- service: string
Oracle Database接続を定義している場合、サービス名。
- sid: string
Oracle Databaseを一意に識別するOracleシステムID (SID)。Oracle Database接続の場合、かわりにserviceを使用しないかぎり、必須です。
- subtype: string
指定可能な値:
[ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE" ]外部ソースのタイプ。サポートされているソースおよびバージョンは、動作保証マトリックス(プラットフォームSQL表)の「データベース」セクションを参照してください。
- token: string
- type(required): string
指定可能な値:
[ "FILE", "DB", "ESSBASE" ]必須。接続のタイプ。サーバー上のファイルに接続する場合は
FILE、外部ソース・システムに接続する場合はDB、別のキューブに接続する場合はESSBASE。 - user: string
必須。この接続のリモート・ソースへのアクセスを認可されているユーザーID。
- walletPath: string
Autonomous Data Warehouseへの接続に必要な場合(repoWallet = falseの場合)、ウォレット・ファイルへのパス。例:
/system/wallets/EssbaseADWS。Oracle Cloud InfrastructureでAutonomous Data Warehouseの「管理」ページから「クライアント資格証明(ウォレット)のダウンロード」を選択してウォレット・ファイルを取得します。すでに使用可能な接続(リポジトリ接続)を使用している場合、ウォレットをアップロードする必要はありません。
レスポンス
- application/json
- application/xml
200 レスポンス
OK
接続が正常に更新されました。
object- catalog: boolean
- datasource: string
- dbDriver: string
オプション。typeが
DBである場合に、汎用JDBCドライバを使用するようにEssbaseを構成するには、JDBCドライバの完全修飾クラス名を指定します。oracle.jdbc.driver.OracleDriverなどです。 - dbURL: string
外部RDBMSデータベースへのURLまたはEssbaseインスタンスへの検出URL。他のEssbaseインスタンスへの接続の場合、このパラメータはhostおよびportを指定するかわりになります。Essbase検出URLの例:
https://192.0.2.1:443/essbase/agent。他の使用方法の例は、グローバルな「接続の取得」エンドポイントのドキュメントを参照してください。 - description: string
この接続の説明文字列。
- encrypted: boolean
- host: string
ホスト・サーバー名またはIP。Oracle Database接続の場合、必須です。Essbase接続の場合、かわりにdbURLを使用しないかぎり、必須です。
- links: array links
- maxPoolSize: integer(int32)
最大接続プール・サイズ。デフォルトは50です。接続エラーが発生した場合、最小および最大接続プール・サイズの調整が必要になることがあります。Universal Connection Pool開発者ガイドのUCPでのプール・サイズの制御についてを参照してください。
- minPoolSize: integer(int32)
最小接続プール・サイズ。デフォルトは5です。接続エラーが発生した場合、最小および最大接続プール・サイズの調整が必要になることがあります。Universal Connection Pool開発者ガイドのUCPでのプール・サイズの制御についてを参照してください。
- name(required): string
この接続の名前。
- password: string
必須。この接続のリモート・ソースへのアクセスを認可されているユーザーIDのパスワード。
- path: string
ファイル・タイプ接続の場合、必須です。データのファイル・ソースへのカタログ・パス。例: /gallery/Technical/Drill Through/DrillthroughDS.csv
- port: integer(int32)
リモート・ホストのポート番号。hostが指定されているときの接続の場合、必須です。
- repoWallet: boolean
すでに使用可能なAutonomous Data Warehouse接続(リポジトリ接続)を使用している場合、trueに設定します。その場合、ウォレットをアップロードする必要はありません。
- schema: string
- service: string
Oracle Database接続を定義している場合、サービス名。
- sid: string
Oracle Databaseを一意に識別するOracleシステムID (SID)。Oracle Database接続の場合、かわりにserviceを使用しないかぎり、必須です。
- subtype: string
指定可能な値:
[ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE" ]外部ソースのタイプ。サポートされているソースおよびバージョンは、動作保証マトリックス(プラットフォームSQL表)の「データベース」セクションを参照してください。
- token: string
- type(required): string
指定可能な値:
[ "FILE", "DB", "ESSBASE" ]必須。接続のタイプ。サーバー上のファイルに接続する場合は
FILE、外部ソース・システムに接続する場合はDB、別のキューブに接続する場合はESSBASE。 - user: string
必須。この接続のリモート・ソースへのアクセスを認可されているユーザーID。
- walletPath: string
Autonomous Data Warehouseへの接続に必要な場合(repoWallet = falseの場合)、ウォレット・ファイルへのパス。例:
/system/wallets/EssbaseADWS。Oracle Cloud InfrastructureでAutonomous Data Warehouseの「管理」ページから「クライアント資格証明(ウォレット)のダウンロード」を選択してウォレット・ファイルを取得します。すでに使用可能な接続(リポジトリ接続)を使用している場合、ウォレットをアップロードする必要はありません。
400 レスポンス
不正なリクエスト
接続の更新に失敗しました。
例
次の例では、既存のアプリケーションレベル接続を更新する方法を示します。
この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。
cURLコマンドを含むスクリプト
call properties.bat
curl -X PUT "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/OracleDB" -H Accept:application/json -H Content-Type:application/json --data "@./app_conn_details_update.json" -u %User%:%Password%前述のcURLの例では、JSONペイロードがapp_conn_details_update.jsonで配信されます。ペイロードに含める必要がある詳細は、どのような種類の接続を更新するかによって異なります。Oracle Database接続を更新する場合の例を次に示します。
サンプルのJSONペイロード - Oracle Database
app_conn_details_update.jsonでREST APIに渡される次のサンプルのJSONペイロードは、Oracle Databaseへの接続を更新する場合の例です。必須パラメータは、name、type、subtype、host、port、service (またはsid)、userおよびpasswordです。
{
"name" : "OracleDB",
"type" : "DB",
"subtype" : "ORACLE",
"host" : "dbhostname.example.com",
"port" : 1521,
"user" : "essbase",
"password" : "cGE1NXdvcmQx",
"service" : "orclpdb.example.com"
}Essbaseでサポートされているソースへの接続をテスト、更新および作成するために使用できるJSONペイロードの詳細な例は、「接続の作成」エンドポイントを参照してください。
レスポンス本体の例
次の例では、レスポンス本体の内容をJSON形式で示します。
{
"name" : "OracleDB",
"description" : "Updated connection to Database",
"type" : "DB",
"subtype" : "ORACLE",
"minPoolSize" : 5,
"maxPoolSize" : 60,
"host" : "dbhostname.example.com",
"port" : 1521,
"user" : "essbase",
"service" : "orclpdb.example.com",
"links" : [ ]
}