1. Oracle EssbaseのREST API
  2. タスク
  3. グローバル接続

グローバル接続の取得

get

/essbase/rest/v1/connections/{connectionName}

指定されたグローバル接続について詳細を返します。

リクエスト

パス・パラメータ
問合せパラメータ

  • trueに設定した場合は、結果で暗号化パスワードが返されます。

先頭に戻る

レスポンス

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

200 レスポンス

OK

接続の詳細が正常に返されました。

本体()
ルート・スキーマ : 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の「管理」ページから「クライアント資格証明(ウォレット)のダウンロード」を選択してウォレット・ファイルを取得します。すでに使用可能な接続(リポジトリ接続)を使用している場合、ウォレットをアップロードする必要はありません。

400 レスポンス

不正なリクエスト

接続詳細の取得に失敗しました。

先頭に戻る

例

次の例では、特定のグローバル接続の詳細を取得する方法を示します。

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

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

次の例では、oraConnという名前のグローバル接続の詳細を取得します。

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/connections/oraConn?links=none" -H Accept:application/json -u %User%:%Password%

レスポンス本体の例 - Oracle Database接続

次の例は、接続先がOracle Databaseである場合の、JSON形式のレスポンス本体の内容を示しています。

{
  "name" : "oraConn",
  "description" : "Oracle Database connection",
  "type" : "DB",
  "subtype" : "ORACLE",
  "minPoolSize" : 5,
  "maxPoolSize" : 50,
  "host" : "dbhost.example.com",
  "port" : 1521,
  "user" : "SAMPLE",
  "sid" : "orcl",
  "links" : [ ]
}

レスポンス本体の例 - ファイル接続

次の例は、接続先がファイルである場合の、JSON形式のレスポンス本体の内容を示しています。

{
  "name" : "fileConn",
  "description" : "CSV file connection",
  "type" : "FILE",
  "subtype" : "FILE",
  "path" : "/shared/Dim_Year.csv",
  "minPoolSize" : 5,
  "maxPoolSize" : 50,
  "links" : [ ]
}

レスポンス本体の例 - Essbase接続

次の例は、接続先が別のEssbaseキューブである場合の、JSON形式のレスポンス本体の内容を示しています。

{
  "name" : "essConn",
  "description" : "Essbase 2 connection",
  "type" : "ESSBASE",
  "subtype" : "ESSBASE",
  "minPoolSize" : 5,
  "maxPoolSize" : 50,
  "dbURL" : "https://esscube.example.com:9001/essbase/agent",
  "user" : "admin",
  "links" : [ ]
}

レスポンス本体の例 - IBM DB2接続

{
  "name" : "DB2Conn",
  "description" : "IBM DB2 connection",
  "type" : "DB",
  "subtype" : "DB2",
  "dbURL" : "jdbc:oracle:db2://db2host.example.com:50000;DatabaseName=tbc",
  "dbDriver" : "com.oracle.bi.jdbc.db2.DB2Driver",
  "host" : db2host.example.com",
  "port" : 50000,
  "user" : "user1",
  "service" : "svcname",
  "links" : [ ]
}

レスポンス本体の例 - Microsoft SQL接続

{
  "name" : "MSSQLConn",
  "description" : "Microsoft SQL connection",
  "type" : "DB",
  "subtype" : "MS_SQL",
  "dbURL" : "jdbc:oracle:sqlserver://mssqlhost.example.com:1433",
  "dbDriver" : "com.oracle.bi.jdbc.sqlserver.SQLServerDriver",
  "host" : "mssqlhost.example.com",
  "port" : 1433,
  "user" : "user1",
  "links" : [ ]
}

レスポンス本体の例 - MySQL接続

{
  "name" : "MySQLConn",
  "description" : "MySQL connection",
  "type" : "DB",
  "subtype" : "MYSQL",
  "dbURL" : "jdbc:oracle:mysql://mysqlhost.example.com:3306",
  "dbDriver" : "com.oracle.bi.jdbc.mysql.MySQLDriver",
  "host" : "mysqlhost.example.com",
  "port" : 3306,
  "user" : "user1",
  "links" : [ ]
}

レスポンス本体の例 - Spark接続

{
  "name" : "SparkConn",
  "description" : "Spark connection",
  "type" : "DB",
  "subtype" : "SPARK",
  "dbURL" : "jdbc:oracle:sparksql://sparkhost.example.com:10000",
  "dbDriver" : "com.oracle.bi.jdbc.sparksql.SparkSQLDriver",
  "host" : "sparkhost.example.com",
  "port" : 10000,
  "user" : "user1",
  "links" : [ ]
}

レスポンス本体の例 - Oracle JDBC接続

{
  "name" : "oracle_jdbc",
  "description" : "Oracle JDBC driver connection",
  "type" : "DB",
  "subtype" : "JDBC",
  "dbURL" : "jdbc:oracle:thin:@dbhost.example.com:1521/orclpdb.example.com",
  "dbDriver" : "oracle.jdbc.driver.OracleDriver",
  "user" : "user1",
  "links" : [ ]
}

レスポンス本体の例 - Microsoft SQL JDBC接続

{
  "name" : "mssql_jdbc",
  "description" : "Microsoft SQL JDBC driver connection",
  "type" : "DB",
  "subtype" : "JDBC",
  "dbURL" : "jdbc:sqlserver://mysqlhost.example.com:1433;databaseName=TBC",
  "dbDriver" : "com.microsoft.sqlserver.jdbc.SQLServerDriver",
  "user" : "TBC",
  "links" : [ ]
}

レスポンス本体の例 - Teradata JDBC接続

{
  "name" : "tera_jdbc",
  "description" : "Teradata JDBC driver connection",
  "type" : "DB",
  "subtype" : "JDBC",
  "dbURL" : "jdbc:teradata://10.x.x.x/TBC",
  "dbDriver" : "com.teradata.jdbc.TeraDriver",
  "user" : "TBC",
  "links" : [ ]
}
先頭に戻る