1. Oracle EssbaseのREST API
  2. タスク
  3. アプリケーション接続

アプリケーション接続の作成

post

/essbase/rest/v1/applications/{applicationName}/connections

指定された入力内容に基づいてアプリケーションレベルの接続を作成します。nameおよびtypeは、すべてのタイプの接続に必須の入力内容です。必要なその他の入力内容は、接続のタイプによって異なります。アプリケーション・マネージャであるか、または指定されたアプリケーションに対するアプリケーション管理権限を持つパワー・ユーザーである必要があります。

接続には、外部サーバーとそのサーバーへのアクセスに必要なログイン資格証明に関する情報を保管します。複数のプロセスおよびアーティファクトで使用可能な1つの接続を定義することによって、分析の多くの側面を簡略化できます。

Autonomous Data Warehouseへの接続を作成している場合は、アプリケーション接続ウォレット・ファイルのアップロードも参照してください。

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
本体()

接続の詳細。

ルート・スキーマ : connection
型: object
ソースの表示

  • オプション。typeがDBである場合に、汎用JDBCドライバを使用するようにEssbaseを構成するには、JDBCドライバの完全修飾クラス名を指定します。oracle.jdbc.driver.OracleDriverなどです。

  • 外部RDBMSデータベースへのURLまたはEssbaseインスタンスへの検出URL。他のEssbaseインスタンスへの接続の場合、このパラメータはhostおよびportを指定するかわりになります。Essbase検出URLの例: https://192.0.2.1:443/essbase/agent。他の使用方法の例は、グローバルな「接続の取得」エンドポイントのドキュメントを参照してください。

  • この接続の説明文字列。

  • ホスト・サーバー名またはIP。Oracle Database接続の場合、必須です。Essbase接続の場合、かわりにdbURLを使用しないかぎり、必須です。

  • links

  • 最大接続プール・サイズ。デフォルトは50です。接続エラーが発生した場合、最小および最大接続プール・サイズの調整が必要になることがあります。Universal Connection Pool開発者ガイドのUCPでのプール・サイズの制御についてを参照してください。

  • 最小接続プール・サイズ。デフォルトは5です。接続エラーが発生した場合、最小および最大接続プール・サイズの調整が必要になることがあります。Universal Connection Pool開発者ガイドのUCPでのプール・サイズの制御についてを参照してください。

  • この接続の名前。

  • 必須。この接続のリモート・ソースへのアクセスを認可されているユーザーIDのパスワード。

  • ファイル・タイプ接続の場合、必須です。データのファイル・ソースへのカタログ・パス。例: /gallery/Technical/Drill Through/DrillthroughDS.csv

  • リモート・ホストのポート番号。hostが指定されているときの接続の場合、必須です。

  • すでに使用可能なAutonomous Data Warehouse接続(リポジトリ接続)を使用している場合、trueに設定します。その場合、ウォレットをアップロードする必要はありません。

  • Oracle Database接続を定義している場合、サービス名。

  • Oracle Databaseを一意に識別するOracleシステムID (SID)。Oracle Database接続の場合、かわりにserviceを使用しないかぎり、必須です。

  • 指定可能な値: [ "TEMPLATE", "EXCELFILE", "DB", "DELIMITEDFILE", "FIXEDWIDTHFILE", "ESSBASE", "JDBC", "SPARK", "MS_SQL", "MYSQL", "DB2", "ORACLE", "FILE" ]

    外部ソースのタイプ。サポートされているソースおよびバージョンは、動作保証マトリックス(プラットフォームSQL表)の「データベース」セクションを参照してください。

  • 指定可能な値: [ "FILE", "DB", "ESSBASE" ]

    必須。接続のタイプ。サーバー上のファイルに接続する場合はFILE、外部ソース・システムに接続する場合はDB、別のキューブに接続する場合はESSBASE。

  • 必須。この接続のリモート・ソースへのアクセスを認可されているユーザーID。

  • Autonomous Data Warehouseへの接続に必要な場合(repoWallet = falseの場合)、ウォレット・ファイルへのパス。例: /system/wallets/EssbaseADWS。Oracle Cloud InfrastructureでAutonomous Data Warehouseの「管理」ページから「クライアント資格証明(ウォレット)のダウンロード」を選択してウォレット・ファイルを取得します。すでに使用可能な接続(リポジトリ接続)を使用している場合、ウォレットをアップロードする必要はありません。

先頭に戻る

レスポンス

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

200 レスポンス

OK

接続が正常に作成されました。

400 レスポンス

不正なリクエスト

接続の作成に失敗しました。

先頭に戻る

例

次の例では、アプリケーションレベルの接続を作成する方法を示します。

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

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

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections" -H Accept:application/json -H Content-Type:application/json --data "@./app_conn_details.json" -u %User%:%Password%

前述のcURLの例では、JSONペイロードがapp_conn_details.jsonで配信されます。ペイロードに含める詳細によって、どのような種類の接続が作成されるかが決まります。Essbaseでサポートされる各種ソースへの接続の作成例は、次を参照してください。

サンプルのJSONペイロード - Oracle Database

app_conn_details.jsonでREST APIに渡される次のサンプルのJSONペイロードは、Oracle Databaseへの接続を作成する場合の例です。必須パラメータは、name、type、subtype、host、port、user、password、およびsidまたはserviceのいずれかです。 

{
  "name" : "OracleDB",
  "type" : "DB",
  "subtype" : "ORACLE",
  "host" : "dbhostname.example.com",
  "port" : 1521,
  "user" : "essbase",
  "password" : "cGE1NXdvcmQx",
  "sid" : "orcl"
}

サンプルのJSONペイロード - Oracle Database Autonomous Data Warehouse

app_conn_details.jsonでREST APIに渡される次のサンプルのJSONペイロードは、Oracle Autonomous Data Warehouseへの接続を作成する場合の例です。必須パラメータは、name、type、subtype、user、passwordおよびserviceです。 

{
  "name" : "OracleADW",
  "type" : "DB",
  "subtype" : "ORACLE",
  "walletPath" : "/system/wallets/Sample",
  "repoWallet" : "false",
  "user" : "essbase",
  "password" : "cGE1NXdvcmQx",
  "service" : "adwsql_low"
}

サンプルのJSONペイロード - ファイル

app_conn_details.jsonでREST APIに渡される次のサンプルのJSONペイロードは、カタログ内のファイルへの接続を作成する場合の例です。必須パラメータは、name、typeおよびpathです。 

{
  "name" : "fileConn",
  "type" : "FILE",
  "path" : "/shared/Dim_Year.csv"
}

サンプルのJSONペイロード - Essbase

app_conn_details.jsonでREST APIに渡される次のサンプルのJSONペイロードは、別のEssbaseキューブへの接続を作成する場合の例です。必須パラメータは、name、type、host + port (またはdbURL)、userおよびpasswordです。 

{
  "name" : "essConn",
  "type" : "ESSBASE",
  "dbURL" : "https://esscube.example.com:9001/essbase/agent",
  "user" : "admin",
  "password" : "cGE1NXdvcmQx"
}

サンプルのJSONペイロード - IBM DB2

app_conn_details.jsonでREST APIに渡される次のサンプルのJSONペイロードは、DB2への接続を作成する場合の例です。必須パラメータは、name、type、subtype、dbDriver、host + port+ service (またはdbURL)、userおよびpassword。 

{
  "name" : "DB2Conn",
  "type" : "DB",
  "subtype" : "DB2",
  "dbDriver" : "com.oracle.bi.jdbc.db2.DB2Driver",
  "host" : db2host.example.com",
  "port" : 50000,
  "user" : "user1",
  "password" : "cGE1NXdvcmQx",
  "service" : "dbname"
}

DB2用の代替ペイロード

DB2への接続を作成する次のサンプルのJSONペイロードでは、host、portおよびserviceは要求されません。dbURLでこれらの情報を指定するためです。 

{
  "name" : "DB2Conn",
  "type" : "DB",
  "subtype" : "DB2",
  "dbURL" : "jdbc:oracle:db2://db2host.example.com:50000;DatabaseName=dbname",
  "dbDriver" : "com.oracle.bi.jdbc.db2.DB2Driver",
  "user" : "user1",
  "password" : "cGE1NXdvcmQx"
}

サンプルのJSONペイロード - Microsoft SQL Server

app_conn_details.jsonでREST APIに渡される次のサンプルのJSONペイロードは、Microsoft SQL Serverへの接続を作成する場合の例です。必須パラメータは、name、type、subtype、dbDriver、host + port (またはdbURL)、userおよびpasswordです。 

{
  "name" : "MSSQLConn",
  "type" : "DB",
  "subtype" : "MS_SQL",
  "dbDriver" : "com.oracle.bi.jdbc.sqlserver.SQLServerDriver",
  "host" : "mssqlhost.example.com",
  "port" : 1433,
  "user" : "user1",
  "password" : "cGE1NXdvcmQx"
}

Microsoft SQL Server用の代替ペイロード

Microsoft SQL Serverへの接続を作成する次のサンプルのJSONペイロードでは、hostおよびportは要求されません。dbURLでこれらの情報を指定するためです。 

{
  "name" : "MSSQLConn"
  "type" : "DB",
  "subtype" : "MS_SQL",
  "dbURL" : "jdbc:oracle:sqlserver://mssqlhost.example.com:1433",
  "dbDriver" : "com.oracle.bi.jdbc.sqlserver.SQLServerDriver",
  "user" : "user1",
  "password" : "cGE1NXdvcmQx"
}

サンプルのJSONペイロード - MySQL

app_conn_details.jsonでREST APIに渡される次のサンプルのJSONペイロードは、MySQLへの接続を作成する場合の例です。必須パラメータは、name、type、subtype、dbDriver、host + port (またはdbURL)、userおよびpasswordです。 

{
  "name" : "MySQLConn",
  "type" : "DB",
  "subtype" : "MYSQL",
  "dbDriver" : "com.oracle.bi.jdbc.mysql.MySQLDriver",
  "host" : "mysqlhost.example.com",
  "port" : 3306,
  "user" : "user1",
  "password" : "cGE1NXdvcmQx"
}

MySQL用の代替ペイロード

MySQLへの接続を作成する次のサンプルのJSONペイロードでは、hostおよびportは要求されません。dbURLでこれらの情報を指定するためです。 

{
  "name" : "MySQLConn"
  "type" : "DB",
  "subtype" : "MYSQL",
  "dbURL" : "jdbc:oracle:sqlserver://mysqlhost.example.com:3306",
  "dbDriver" : "com.oracle.bi.jdbc.mysql.MySQLDriver",
  "user" : "user1",
  "password" : "cGE1NXdvcmQx"
}

サンプルのJSONペイロード - Spark

app_conn_details.jsonでREST APIに渡される次のサンプルのJSONペイロードは、Sparkへの接続を作成する場合の例です。必須パラメータは、name、type、subtype、dbDriver、host + port (またはdbURL)、userおよびpasswordです。 

{
  "name" : "SparkConn",
  "type" : "DB",
  "subtype" : "SPARK",
  "dbDriver" : "com.oracle.bi.jdbc.sparksql.SparkSQLDriver",
  "host" : "sparkhost.example.com",
  "port" : 10000,
  "user" : "user1",
  "password" : "cGE1NXdvcmQx"
}

Spark用の代替ペイロード

Sparkへの接続を作成する次のサンプルのJSONペイロードでは、hostおよびportは要求されません。dbURLでこれらの情報を指定するためです。 

{
  "name" : "SparkConn"
  "type" : "DB",
  "subtype" : "SPARK",
  "dbURL" : "jdbc:oracle:sparksql://sparkhost.example.com:10000",
  "dbDriver" : "com.oracle.bi.jdbc.sparksql.SparkSQLDriver",
  "user" : "user1",
  "password" : "cGE1NXdvcmQx"
}

サンプルのJSONペイロード - Oracle Database (JDBC)

app_conn_details.jsonでREST APIに渡される次のサンプルのJSONペイロードは、JDBCを使用しているOracle Databaseへの接続を作成する場合の例です。このタイプの接続を使用するには、最初に汎用JDBCドライバの接続およびデータソースの作成の説明に従って、汎用JDBCドライバを使用するようにEssbaseを構成しておく必要があります。必須パラメータは、name、type、subtype、dbURL、dbDriver、userおよびpasswordです。 

{
  "name" : "oracle_jdbc",
  "type" : "DB",
  "subtype" : "JDBC",
  "dbURL" : "jdbc:oracle:thin:@dbhost.example.com:1521/orclpdb.example.com",
  "dbDriver" : "oracle.jdbc.driver.OracleDriver",
  "user" : "user1",
  "password" : "cGE1NXdvcmQx"
}

サンプルのJSONペイロード - Teradata (JDBC)

app_conn_details.jsonでREST APIに渡される次のサンプルのJSONペイロードは、JDBCを使用しているTeradataへの接続を作成する場合の例です。このタイプの接続を使用するには、最初に汎用JDBCドライバの接続およびデータソースの作成の説明に従って、汎用JDBCドライバを使用するようにEssbaseを構成しておく必要があります。必須パラメータは、name、type、subtype、dbURL、dbDriver、userおよびpasswordです。 

{
  "name" : "tera_jdbc_conn",
  "type" : "DB",
  "subtype" : "JDBC",
  "dbURL" : "jdbc:teradata://10.x.x.x/TBC",
  "dbDriver" : "com.teradata.jdbc.TeraDriver",
  "user" : "TBC",
  "password" : "cGE1NXdvcmQx"
}
先頭に戻る