機械翻訳について
  1. Oracle Analytics CloudのためのREST API
  2. タスク
  3. カタログ
  4. 接続

接続の更新

put

/api/20210901/catalog/connections/{connectionId}

アナリティクス・インスタンスの既存の接続の1つ以上のプロパティを変更します。 PUT操作では、ペイロードに含めるプロパティのみが上書きされます。 ペイロードから除外する接続プロパティは変更されません。 一部のプロパティは必須であるため、常に指定する必要があります: ユーザー名、パスワードおよびremoteData (remoteData=trueの場合)。 PUT操作では、接続プロパティ・タイプまたはsystemConnectionを変更できません。

リクエスト

パス・パラメータ
  • Base64エンコーディングを使用した接続のID。 たとえば、接続にオブジェクトID 'user'.'connId'がある場合、Base64でエンコードされた値J3VzZXInLidjb25uSWQnを入力
サポートされているメディア・タイプ
リクエスト本文 - application/json ()
ルート・スキーマ: schema
Type: object
先頭に戻る

レスポンス

200レスポンス

成功した操作。

400レスポンス

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

401レスポンス

未承認(資格証明がないか期限切れなど)。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

403レスポンス

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

404レスポンス

見つかりません。 リクエストされたリソースは見つかりませんでした。
本文()
ルート・スキーマ: Error
Type: object
ソースを表示

409レスポンス

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

500レスポンス

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

例

これらの例は、Oracle Autonomous AI Lakehouseへの既存の接続の接続パラメータを更新する方法を示しています。

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

ノート:

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

例1 Autonomous AI Lakehouseへのウォレットレス(TLS)接続の更新

この例では、oracle_ailakehouse_walletlessというOracle Autonomous AI Lakehouseへの既存の接続のユーザー名とパスワードを変更します。 接続のオブジェクトIDは、Base64URLでエンコードされたconnectionId値J2FkbWluJy4nb3JhY2xlX2FpbGFrZWhvdXNlX3dhbGxldGxlc3Mnを持つ'admin'.'oracle_ailakehouse_walletless'です。 リクエストには、単純なJSON本文(application/json)が含まれます。

cURLの例

まず、更新する接続のconnectionIdを決定します。 接続を作成すると、レスポンス本文にconnectionIdが返されます。 これを書き留めなかった場合は、更新する接続のオブジェクトIDを取得し、Base64URLがこの値をエンコードしてconnectionIdを判別できます。 「オブジェクトID」を取得するには、Oracle Analytics Cloudの「接続の検査」ダイアログに移動します。

次に、更新する接続プロパティをリクエスト・ペイロードに含め、リモート・データ接続を使用している場合は"remoteData": Trueを指定します。 たとえば、usernameおよびpasswordを更新する場合、ペイロードは次のようになります。 
{
  "version": "2.0.0", 
  "type": "connection",
  "name": "myConnection", 
  "content": {   
  "connectionParams": {
        "username": "NEWADMIN",
        "password": "<<updated-password>>",
        "filePath": "users/admin/ConnectionsNew",
        "remoteData": True   
        } 
   }
}

JSONペイロードを指定してcURLコマンドを実行します。

curl -i \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --request PUT 'https://<hostname>/api/20210901/catalog/connections/J2FkbWluJy4nb3JhY2xlX2FpbGFrZWhvdXNlX3dhbGxldGxlc3Mn' \
  --data "{  \
          "version": "2.0.0",    \
          "type": "connection",  \
          "name": "myConnection",  \
          "content": {            \
            "connectionParams": {     \
              "username": "NEWADMIN",  \
              "password": "<<updated-password>>", \
              "filePath": "users/admin/ConnectionsNew", \
              "remoteData": True  \
             }   
           }
       }"

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

適用不可。

レスポンス本文の例

成功した場合、レスポンス本文は200レスポンス・コードを返します。 たとえば: 

Status 200

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

この例では、oracle_ailakehouse_with_walletという名前の接続をオブジェクトID 'admin'.'oracle_ailakehouse_with_wallet'で更新します。 この接続タイプのリクエスト本文には、multipart/form-dataを含めることができます。 ウォレット・ファイルupdated-cwallet.ssoを更新し、接続のusernameおよびpasswordパラメータも変更します。

cURLの例

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

Base64URLは、接続のオブジェクトID値をエンコードしてconnectionIdを決定します。 この例では、connectionIdはJ2FkbWluJy4nb3JhY2xlX2FpbGFrZWhvdXNlX3dpdGhfd2FsbGV0Jw== です。

次に、更新する接続プロパティをリクエスト・ペイロードに含め、リモート・データ接続を使用している場合は"remoteData": Trueを指定します。 usernameおよびpasswordを更新する場合、ペイロードは次のようになります。 
{
  "version": "2.0.0", 
  "type": "connection",
  "name": "myConnection", 
  "content": {   
  "connectionParams": {
        "username": "NEWADMIN",
        "password": "<<<updated-password>>>>",
        "remoteData": True   
        } 
   }
}

更新されたウォレット・ファイル(updated-cwallet.sso)と更新する接続プロパティを含むcURLコマンドを実行します。 

curl -i \
 --header 'Authorization: Bearer <token>' \
 --request PUT 'https://<hostname>/api/20210901/catalog/connections/J2FkbWluJy4nb3JhY2xlX2FpbGFrZWhvdXNlX3dpdGhfd2FsbGV0Jw==' \
 --form 'cert=@"/Users/admin/Downloads/Wallet_ailakehouse/updated-cwallet.sso"' \
 --form 'connectionParams="{     \
          "version": "2.0.0",    \
          "type": "connection",  \
          "name": "myConnection", \
          "content": {           \
          "connectionParams": {            \
             "username": "NEWADMIN",       \
             "password": "<<<<password>>>>", \
             "remoteData": True  \
             } \
          }"'

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

適用不可。

レスポンス本文の例

成功した場合、レスポンス本文は200レスポンス・コードを返します。 たとえば: 

Status 200
先頭に戻る