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

アプリケーション接続のリスト

get

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

名前、説明およびタイプなどの詳細情報を含め、アプリケーションの接続のリストを返します。

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

リクエスト

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

  • 返す接続のタイプ(指定された場合)

  • 返される最大接続数。デフォルトは50です。

    デフォルト値: 50

  • 結果セットの先頭から省略する接続の数。

    デフォルト値: 0

  • connTypeパラメータとともに使用します。trueに設定した場合は、リポジトリベースのAutonomous Data Warehouse接続を返します。デフォルトはfalseです。

    デフォルト値: false

  • connTypeパラメータとともに使用します。trueに設定した場合は、ウォレットベースのAutonomous Data Warehouse接続を返します。デフォルトはfalseです。

    デフォルト値: false
先頭に戻る

レスポンス

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

200 レスポンス

OK

接続のリストが正常に返されました。

本体()
ルート・スキーマ : ConnectionsList
型: object
ソースの表示
ネストされたスキーマ : items
型: array
ソースの表示
ネストされたスキーマ : properties
型: object
使用可能なその他のプロパティ
ソースの表示
ネストされたスキーマ : 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 レスポンス

不正なリクエスト

接続のリストに失敗しました。

先頭に戻る

例

次の例では、Essbaseアプリケーションの接続リストを取得する方法を示します。

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

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

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

レスポンス本体の例

次の例では、レスポンス本体の内容をJSON形式で示します。

{
  "items" : [ {
    "name" : "Essbase2",
    "description" : "Connection to Essbase instance 2",
    "type" : "ESSBASE",
    "subtype" : "ESSBASE",
    "minPoolSize" : 5,
    "maxPoolSize" : 50,
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/Essbase2",
      "method" : "GET"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/Essbase2",
      "method" : "PUT"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/Essbase2",
      "method" : "DELETE"
    }, {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/Essbase2/actions/test",
      "method" : "POST"
    } ]
  }, {
    "name" : "OracleDB",
    "description" : "Connection to Database",
    "type" : "DB",
    "subtype" : "ORACLE",
    "minPoolSize" : 5,
    "maxPoolSize" : 50,
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/OracleDB",
      "method" : "GET"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/OracleDB",
      "method" : "PUT"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/OracleDB",
      "method" : "DELETE"
    }, {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/OracleDB/actions/test",
      "method" : "POST"
    } ]
  }, {
    "name" : "UserDetails",
    "description" : "CSV file of user details",
    "type" : "FILE",
    "subtype" : "FILE",
    "minPoolSize" : 5,
    "maxPoolSize" : 50,
    "links" : [ {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/UserDetails",
      "method" : "GET"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/UserDetails",
      "method" : "PUT"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/UserDetails",
      "method" : "DELETE"
    }, {
      "rel" : "self",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/connections/UserDetails/actions/test",
      "method" : "POST"
    } ]
  } ],
  "offset" : 0,
  "limit" : 50,
  "count" : 3,
  "totalResults" : 3,
  "hasMore" : false
}
先頭に戻る