移動先

• リクエスト
• レスポンス
• 例

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

post

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

指定された入力内容を保存せずに使用して、新規アプリケーション接続または更新したアプリケーション接続をテストします。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

本体()

接続の詳細。

ルート・スキーマ : connection

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

{
    "type":"object",
    "required":[
        "name",
        "type"
    ],
    "properties":{
        "description":{
            "type":"string",
            "description":"<p>A descriptive string for this connection.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>A name for this connection.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>Required. Type of connection. <code>FILE</code> to connect to a file on the server, <code>DB</code> to connect to an external source system, or <code>ESSBASE</code> to connect to another cube.</p>",
            "enum":[
                "FILE",
                "DB",
                "ESSBASE"
            ]
        },
        "path":{
            "type":"string",
            "description":"<p>Required for file type connections. Catalog path to the file source of data. Example: /gallery/Technical/Drill Through/DrillthroughDS.csv</p>"
        },
        "catalog":{
            "type":"boolean"
        },
        "host":{
            "type":"string",
            "description":"<p>Host server name or IP. Required for Oracle Database connections. Required for Essbase connections, unless <i>dbURL</i> is used instead.</p>"
        },
        "port":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Port number on the remote host. Required for connections when <i>host</i> is given.</p>"
        },
        "user":{
            "type":"string",
            "description":"<p>Required. User ID with authorization to access the remote source for this connection.</p>"
        },
        "password":{
            "type":"string",
            "description":"<p>Required. Password of the user ID with authorization to access the remote source for this connection.</p>"
        },
        "encrypted":{
            "type":"boolean"
        },
        "token":{
            "type":"string"
        },
        "sid":{
            "type":"string",
            "description":"<p>The Oracle System ID (SID) that uniquely identifies an Oracle Database. Required for Oracle Database connections unless <i>service</i> is used instead.</p>"
        },
        "service":{
            "type":"string",
            "description":"<p>Service name, if you are defining an Oracle Database connection.</p>"
        },
        "schema":{
            "type":"string"
        },
        "dbURL":{
            "type":"string",
            "description":"<p>URL to an external RDBMS database, or, discovery URL to an Essbase instance. For connections to other Essbase instances, this parameter is an alternative to providing the <i>host</i> and <i>port</i>. Example of Essbase discovery URL <code>https://192.0.2.1:443/essbase/agent</code>. For examples of other uses, see documentation for global Get Connection endpoint.</p>"
        },
        "dbDriver":{
            "type":"string",
            "description":"<p>Optional. If <i>type</i> is <code>DB</code> and you are configuring Essbase to use a generic JDBC driver, provide the fully qualified class name of the JDBC driver. For example, <code>oracle.jdbc.driver.OracleDriver</code>.</p>"
        },
        "datasource":{
            "type":"string"
        },
        "subtype":{
            "type":"string",
            "description":"<p>The type of external source. Supported sources and versions are listed in the Database section of the certification matrix (Platform SQL table).</p>",
            "enum":[
                "TEMPLATE",
                "EXCELFILE",
                "DB",
                "DELIMITEDFILE",
                "FIXEDWIDTHFILE",
                "ESSBASE",
                "JDBC",
                "SPARK",
                "MS_SQL",
                "MYSQL",
                "DB2",
                "ORACLE",
                "FILE"
            ]
        },
        "walletPath":{
            "type":"string",
            "description":"<p>Path to a wallet file, if required for your connection to Autonomous Data Warehouse (if <i>repoWallet</i> = false). Example: <code>/system/wallets/EssbaseADWS</code>. Obtain a wallet file by selecting Download Client Credentials (Wallet) from your Autonomous Data Warehouse Administration page in Oracle Cloud Infrastructure. If you are using a connection which is already available (a repository connection), you do not need to upload a wallet.</p>"
        },
        "repoWallet":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> if you are using an Autonomous Data Warehouse connection which is already available (a repository connection). In this case, you do not need to upload a wallet.</p>"
        },
        "minPoolSize":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Minimum connection pool size. Default is 5. If you get connection errors you may need to adjust minimum and maximum connection pool sizes. See <b>About Controlling the Pool Size in UCP</b> in <i>Universal Connection Pool Developer's Guide</i>.</p>"
        },
        "maxPoolSize":{
            "type":"integer",
            "format":"int32",
            "description":"<p>Maximum connection pool size. Default is 50. If you get connection errors you may need to adjust minimum and maximum connection pool sizes. See <b>About Controlling the Pool Size in UCP</b> in <i>Universal Connection Pool Developer's Guide</i>.</p>"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"connection"
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : Link

型: object

ソースの表示

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

OK

接続のテストが正常に完了しました。

400 レスポンス

不正なリクエスト

接続のテスト中にエラーが発生しました。

先頭に戻る

例

次の例では、新規アプリケーション接続を作成する前にテストする方法を示します。

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

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

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

前述のcURLの例では、JSONペイロードがapp_conn_details.jsonで配信されます。ペイロードに含める詳細によって、どのような種類の接続が作成されるかが決まります。DB2接続をテストする場合の例を次に示します。

サンプルの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"
}

Essbaseでサポートされているソースへの接続をテスト、更新および作成するために使用できるJSONペイロードの詳細な例は、「接続の作成」エンドポイントを参照してください。

レスポンス本体の例

ステータス・コード200 (テストが成功した場合)で始まるヘッダー情報を返します(-iが使用されている場合)。ヘッダー情報は、ステータス・コードのみを示すように切り捨てられています。

HTTP/1.1 200 OK

先頭に戻る