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

接続の更新

put

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

分析インスタンス内の既存の接続の1つ以上のプロパティを変更します。PUT操作では、ペイロードに含めるプロパティのみが上書きされます。ペイロードから除外する接続プロパティは変更されません。ユーザー名とパスワードは必須です。PUT操作では、接続タイプを変更できません。

リクエスト

パス・パラメータ
  • 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 Data Warehouse (ADW)への既存の接続の接続パラメータを更新する方法を示しています。

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

ノート:

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

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

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

cURLの例

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

次に、更新する接続プロパティをリクエスト・ペイロードに含めます。たとえば、usernameおよびpasswordを更新する場合、ペイロードは次のようになります。 
{
  "version": "2.0.0", 
  "type": "connection", 
  "content": {   
  "connectionParams": {
        "username": "NEWADMIN",
        "password": "<<updated-password>>"   
        } 
   }
}

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

curl -i \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' a
  --request PUT 'https://<hostname>/api/20210901/catalog/connections/J2FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw==' \
  --data "{  \
          "version": "2.0.0",    \
          "type": "connection",  \
          "content": {            \
            "connectionParams": {     \
              "username": "NEWADMIN",  \
              "password": "<<updated-password>>" \      
             }   
           }
       }"

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

適用不可。

レスポンス本文の例

成功すると、レスポンス本文で200レスポンス・コードが返されます。たとえば: 

Status 200

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

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

cURLの例

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

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

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

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

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

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

適用不可。

レスポンス本文の例

成功すると、レスポンス本文で200レスポンス・コードが返されます。たとえば: 

Status 200
先頭に戻る