Oracle Analytics CloudのためのREST API

機械翻訳について

接続の作成

post

/api/20210901/catalog/connections

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

リクエスト

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

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

application/json

ルート・スキーマ: schema

Type: object

先頭に戻る

レスポンス

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

application/json

200レスポンス

成功した操作。

ルート・スキーマ: CreateConnectionDetails

Type: object

ソースを表示

connectionId(必須): string

Base64エンコーディングを使用した接続のID。この接続の詳細の取得、検証、変更または削除時にパラメータとして使用します。

{
    "type":"object",
    "properties":{
        "connectionId":{
            "type":"string",
            "description":"The ID of the connection with Base64 encoding. To be used as a parameter when retrieving details, verifying, modifying or deleting this connection."
        }
    },
    "required":[
        "connectionId"
    ]
}

400レスポンス

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

401レスポンス

未承認(資格情報の欠落や期限切れなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

403レスポンス

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

409レスポンス

競合(操作によって制約違反が発生し、操作が現在の状態と互換性がないなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

500レスポンス

内部サーバー・エラー。サーバーで、リクエストの履行を妨げる予期しない状況が発生しました。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

先頭に戻る

例

これらの例は、Oracle AnalyticsインスタンスからOracle Autonomous AI Lakehouseへの接続を作成する方法を示しています。

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

ノート:

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

例1 Oracle Autonomous AI Lakehouseへのウォレットレス(TLS)接続の作成

この例では、oracle_ailakehouse_walletlessという名前の接続を作成します。リクエストには、単純なJSON本文(application/json)が含まれます。 filePathパラメータを使用して、内部に接続を作成するためのカタログ・フォルダを指定することもできます。

cURLの例

まず、接続の作成に必要なプロパティを含むJSONファイルを作成します。たとえば、次のようなペイロードを含むcreate_ailakehouse_walletless_connection.jsonというJSONファイルを作成します。

{
      "version": "2.0.0",
      "type": "connection",
      "name": "oracle_ailakehouse_walletless",
      "description": "Sample Oracle Autonomous AI Lakehouse 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)))",
           "folderPath": "users/admin/Connections",
           "username": "ADMIN",
           "password": "<<password>>",
           "systemConnection": false,        
           "remoteData": false,
           "sslType": "ServerSideSSL"
       }
     }
}

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

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

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

適用不可。

レスポンス本文の例

レスポンス本文にBase64URLでエンコードされたconnectionIdを書き留めます。後で、この値を使用して、この接続を更新または削除できます。

{"connectionID":"J2FkbWluJy4nb3JhY2xlX2FpbGFrZWhvdXNlX3dhbGxldGxlc3Mn"}

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

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

cURLの例

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

接続の作成に必要なプロパティを決定します。ペイロードは次のようになります。

{
    "version": "2.0.0",
    "type": "connection",
    "name": "oracle_ailakehouse_with_wallet",
    "description":
      "Sample Oracle Autonomous AI Lakehouse 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_ailakehouse/cwallet.sso"'        \
 --form 'connectionParams= "{ \
    "version": "2.0.0",       \
    "type": "connection",     \
    "name": "oracle_ailakehouse_with_wallet", \
    "description":  \
      "Sample Oracle Autonomous AI Lakehouse 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"  \  
      }
   }
 }'

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

適用不可。

レスポンス本文の例

レスポンス本文にBase64URLでエンコードされたconnectionIdを書き留めます。後で、この値を使用して、この接続を更新または削除できます。

{"connectionID":"J2FkbWluJy4nb3JhY2xlX2FpbGFrZWhvdXNlX3dpdGhfd2FsbGV0Jw=="}

先頭に戻る