1. Oracle Analytics ServerのためのREST API
  2. タスク
  3. カタログ
  4. 接続

接続の作成

post

/api/20210901/catalog/connections

分析インスタンスの新規接続を作成します。

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされているメディア・タイプ
リクエスト本文 - application/json ()
ルート・スキーマ: schema
Type: object
先頭に戻る

レスポンス

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

200レスポンス

成功した操作。
本文()
ルート・スキーマ: CreateConnectionDetails
Type: object
ソースを表示
  • Base64エンコーディングを使用した接続のID。この接続の詳細の取得、検証、変更または削除時にパラメータとして使用します。

400レスポンス

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

401レスポンス

未承認(資格情報の欠落や期限切れなど)。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

403レスポンス

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

409レスポンス

競合(操作によって制約違反が発生し、操作が現在の状態と互換性がないなど)。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

500レスポンス

内部サーバー・エラー。サーバーで、リクエストの履行を妨げる予期しない状況が発生しました。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示
先頭に戻る

例

次の例では、Oracle AnalyticsインスタンスからOracle Autonomous Data Warehouse (ADW)への接続を作成する方法を示します。

  • 例1 - Oracle ADWへのウォレットなし(TLS)の接続の作成
  • 例2 - 資格証明ウォレット・ファイルcwallet.sso (相互TLS)を使用するOracle ADWへの接続の作成

ノート:

このトピックで説明するJSONペイロードは、Oracle ADWに固有のものです。その他のデータ・ソースでは、JSONペイロードの書式は異なります。サポートされるデータ・ソースのサンプルのJSONペイロードを参照してください。

例1 ADWへのウォレットなし(TLS)の接続の作成

この例では、oracle_adw_walletlessという名前の接続を作成します。リクエストには単純なJSON本文(application/json)が含まれます。

cURLの例

まず、接続の作成に必要なプロパティを含むJSONファイルを作成します。たとえば、create_adw_walletless_connection.jsonというJSONファイルを作成し、次のようなペイロードを含めます。
{
      "version": "2.0.0",
      "type": "connection",
      "name": "oracle_adw_walletless",
      "description": "Sample Oracle ADW connection without a wallet created using Connections API",
      "content": {    
        "connectionParams": {
           "connectionType": "oracle-autonomous-data-warehouse",
           "connectionString": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1521)(host=adb.us-ashburn-1.oraclecloud.com))(connect_data=(service_name=abcdefg1hijkl2m_adwwalletless_high.adb.oraclecloud.com))(security=(ssl_server_dn_match=yes)))",
           "username": "ADMIN",
           "password": "<<password>>",
           "systemConnection": false,        
           "remoteData": false,
           "sslType": "ServerSideSSL"
       }
     }
}

次に、JSONファイル(たとえば、create_adw_walletless_connection.json)をコールするcURLコマンドを実行します。 

curl -i \
 --header 'Authorization: Bearer <token>' \
 --header 'Content-Type: application/json' \
 --request POST 'https://<hostname>/api/20210901/catalog/connections' \
 --data @create_adw_walletless_connection.json

レスポンス・ヘッダーの例

適用不可。

レスポンス本文の例

Base64でエンコードされている、レスポンス本文のconnectionIdをメモします。後から、この値を使用して、接続の更新や削除を実行できます。 

{"connectionID":"J0FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw=="}

例2 ウォレット・ファイル(相互TLS)を使用するADWへの接続の作成

この例では、oracle_adw_with_walletという名前の接続を作成します。リクエスト本文にはmultipart/form-dataが含まれているため、ウォレット・ファイルcwallet.ssoとADW接続パラメータの両方が必要です。

cURLの例

Oracle Autonomous Data Warehouseから資格証明ウォレット・ファイルを取得します。クライアント資格証明(ウォレット)のダウンロードを参照してください。

接続の作成に必要なプロパティを決定します。ペイロードは次のようになります。
{
    "version": "2.0.0",
    "type": "connection",
    "name": "oracle_adw_with_wallet",
    "description":
      "Sample Oracle ADW connection with a wallet created using Connections API",   
      "content": {
       "connectionParams": {
         "connectionType": "oracle-autonomous-data-warehouse",
         "connectionString": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps) (port=1522)(host=adb.us-ashburn-1.oraclecloud.com))(connect_data=(service_name=abcdefg1hijkl2m_walletadw_high.adwc.oraclecloud.com/))(security=(ssl_server_dn_match=yes)))",
         "username": "ADMIN",
         "password": "<<password>>",
         "remoteData": "false",   
         "systemConnection": false,
         "sslType": "ClientSideSSL"    
        }
      }
 }

ウォレット・ファイル(cwallet.sso)および接続プロパティを含むcURLコマンドを実行します。 

curl -i \
 --header 'Authorization: Bearer <token>' \
 --request POST 'https://<hostname>/api/20210901/catalog/connections'  \
 --form 'cert=@"/Users/scott/Downloads/Wallet_adw/cwallet.sso"'        \
 --form 'connectionParams= "{ \
    "version": "2.0.0",       \
    "type": "connection",     \
    "name": "oracle_adw_with_wallet", \
    "description":  \
      "Sample Oracle ADW connection with a wallet created using Connections API",  \
      "content": {   \
       "connectionParams": { \
         "connectionType": "oracle-autonomous-data-warehouse",\
         "connectionString": "(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps) (port=1522)(host=adb.us-ashburn-1.oraclecloud.com))(connect_data=(service_name=abcdefg1hijkl2m_walletadw_high.adwc.oraclecloud.com/))(security=(ssl_server_dn_match=yes)))", \
         "username": "ADMIN", \
         "password": "<<password>>", \
         "remoteData": "false",      \
         "systemConnection": false,  \
         "sslType": "ClientSideSSL"  \  
      }
   }
 }'

レスポンス・ヘッダーの例

適用不可。

レスポンス本文の例

Base64でエンコードされている、レスポンス本文のconnectionIdをメモします。後から、この値を使用して、接続の更新や削除を実行できます。 

{"connectionID":"J2FkbWluJy4nb3JhY2xlX2Fkd193aXRoX3dhbGxldCc="}
先頭に戻る