コネクタと接続 > データ取り込みおよびレプリケーション接続プロパティ > REST V2接続のプロパティ
  

REST V2接続のプロパティ

RESTアーキテクチャで構築されたWebサービスアプリケーションと対話するためのREST V2コネクタを作成します。

前提条件

REST V2接続を設定する前に、前提条件を必ず満たすようにしてください。

REST V2への接続

RESTアーキテクチャ上に構築されたWebサービスアプリケーションと対話するようにREST V2の接続プロパティを設定してみましょう。

始める前に

開始する前に、前提条件を必ず満たすようにしてください。

接続の詳細

次の表に、基本接続プロパティを示します。
プロパティ
説明
接続名
接続の名前。
各接続名は組織内で一意である必要があります。接続名には、英数字、スペース、および次の特殊文字を含めることができます。_ .+ -,
最大長は255文字です。
説明
接続の説明。最大長は4000文字です。
タイプ
REST V2
ランタイム環境
タスクを実行するランタイム環境の名前。
Secure Agent、ホステッドエージェント、またはサーバーレスランタイム環境を選択します。
Hosted Agentやサーバーレスランタイム環境でストリーミング取り込みタスクを実行することはできません。

認証タイプ

標準のOAuth 2.0クライアント資格情報、OAuth 2.0認証コード、JWTベアラートークンおよびAPIキー認証タイプを設定して、RESTエンドポイントに接続できます。
必要な認証方法を選択し、認証固有のパラメータを設定します。

詳細設定

次の表に、詳細接続のプロパティを示します。
プロパティ
説明
トラストストアファイルパス
REST APIとの一方向または双方向の安全な接続を確立するためのTLS証明書を含むトラストストアファイルの絶対パス。各Secure Agentマシンで使用可能なディレクトリパスを指定します。
トラストストアファイル名とパスワードをJVMオプションとして設定することもできますし、証明書を次のディレクトリにインポートすることもできます。
<Secure Agentのインストールディレクトリ>\jre\lib\security\cacerts
サーバーレスランタイム環境の場合、サーバーレスエージェントディレクトリでトラストストアファイルパスを指定します。
例: /home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks
トラストストアのパスワード
SSL証明書を含むトラストストアファイルのパスワード。
トラストストアのパスワードをJVMオプションとして設定することもできます。
キーストアファイルパス
REST APIとの双方向の安全な接続を確立するために必要なキーと証明書を含むキーストアファイルの絶対パス。各Secure Agentマシンで使用可能なディレクトリパスを指定します。
また、キーストアファイル名とパスをJVMオプションとして設定するか、証明書を任意のディレクトリにインポートすることもできます。
サーバーレスランタイム環境の場合、サーバーレスエージェントディレクトリでキーストアファイルパスを指定します。
例: /home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks
キーストアのパスワード
通信を安全に行うために必要なキーストアファイルのパスワードです。
キーストアのパスワードをJVMオプションとして設定することもできます。
プロキシタイプ
プロキシのタイプ。
次のいずれかのオプションを選択します。
  • - プロキシなし: エージェントレベルまたは接続レベルで設定されたプロキシサーバーをバイパスします。
  • - プラットフォームプロキシ: エージェントで設定されたプロキシを考慮します。
  • - カスタムプロキシ: 接続プロパティで設定されたプロキシを考慮します。
プロキシ構成
プロキシを設定するために必要な形式。
次の形式を使用してプロキシを設定します:
<ホスト>:<ポート>
認証されたプロキシサーバーを設定することはできません。
詳細フィールド
エージェントがRESTエンドポイントに接続するときに使用する引数を入力します。
複数の引数を指定する場合は、それぞれの引数をセミコロンで区切ります。
例:
connectiondelaytime:10000;retryattempts:5
次のような引数を指定することができます。
  • - ConnectionTimeout。RESTエンドポイントからの応答を取得するための待機時間(ミリ秒)。接続タイムアウトを過ぎると、接続は終了します。
  • デフォルトはエンドポイントAPIで定義されているタイムアウトです。
    注: REST V2接続タイムアウトとエンドポイントAPIタイムアウトの両方が定義されている場合、接続は定義されている最短のタイムアウトで終了します。
  • - connectiondelaytime。RESTエンドポイントに要求を送信するための遅延時間(ミリ秒)。
  • デフォルトは10000です。
  • - retryattempts。応答で400および500シリーズのエラーコードが返された場合に接続が試行された回数。
  • デフォルトは3です。再試行を無効にするには0を指定します。
  • - qualifiedSchema。選択したスキーマが修飾されているかどうかを指定します。
  • デフォルトはfalseです。
注: ストリーミング取り込みとレプリケーションタスクでは、ConnectionTimeoutおよびretryattemptsのみが適用されます。

TLS認証によるセキュアな通信

TLS認証を設定して、Secure AgentとREST API over TLSとの間に一方向または双方向のセキュアな通信を確立します。
一方向のセキュアな通信を確立するには、次の手順を実行します。
  1. 1トラストストアを生成します。手順の詳細については、「トラストストアの生成」を参照してください。
  2. 2REST V2接続を一方向SSL用に設定します。トラストストアファイルとトラストストアパスワードは、接続で指定するか、Secure AgentのJVMオプションで設定することができます。
双方向のセキュアな通信を確立するには、まず一方向のセキュアな通信を設定してから、次の手順を実行する必要があります。
  1. 1キーストアを生成します。手順の詳細については、「キーストアの生成」を参照してください。
  2. 2REST V2接続を双方向SSL用に設定します。キーストアファイルとキーストアパスワードは、接続で指定するか、Secure AgentのJVMオプションで設定することができます。
接続とJVMオプションでキーストアとトラストストアのプロパティを指定すると、Secure Agentでは接続で設定されたプロパティに基づいて証明書が処理されます。

トラストストアの生成

トラストストアを生成するには、サーバー証明書が必要です。サーバー証明書を取得し、次の手順を実行してトラストストアを生成します。
  1. 1サーバー証明書を、Secure Agentインストール内で使用可能な次のいずれかのディレクトリにインポートします。
  2. 2トラストストアを生成するには、コマンドラインから次のコマンドを実行します。
  3. keytool -importcert -alias <エイリアス名をここで指定します> -file <サーバー証明書をここで指定します> -keystore <生成するカスタムトラストストアの名前を指定します> -storepass <カスタムトラストストアのパスワードを指定します>
    例: keytool -importcert -alias RESTV2CACert -file ca.pem -keystore sampletruststore -storepass JKSTrustStorePassword
    この例では、sampletruststoreという名前とJKSTrustStorePasswordというパスワードでトラストストアファイルが生成されます。

キーストアの生成

キーストアを生成するには、クライアント証明書とクライアントシークレットキーが必要です。クライアント証明書とクライアントシークレットキーを取得し、次の手順を実行してキーストアを生成します。
  1. 1サーバー証明書を、Secure Agentインストール内で使用可能な次のいずれかのディレクトリにインポートします。
  2. 2キーストアを生成するには、コマンドラインから次のコマンドを実行します。
  3. openssl pkcs12 -export -in <ここでクライアント証明書を指定します> -inkey <ここでプライベートキーを指定します> -name "<ここに任意の名前を指定します>" -passout pass:<生成するキーストアのパスワードを指定します> -out <p12拡張子を使用してキーストアの名前を指定します>
    例: openssl pkcs12 -export -in /home/samplefolder/certs/client-cert.pem -inkey /home/samplefolder/certs/client-key.pem -name "restclient" -passout pass:PKCSKeyStorePassword -out samplekeystore.p12
    この例では、samplekeystore.p12はPKCS12形式で生成されます。
    キーストアファイルを.p12形式から.jks形式に変換するには、コマンドラインから次のコマンドを実行します。
    keytool -importkeystore -srckeystore <p12キーストアファイルの名前を指定します> -srcstoretype pkcs12 -srcstorepass <生成されたp12キーストアファイルのパスワードを指定します> -destkeystore <JKSキーストアファイルの名前を指定します> -deststoretype JKS -deststorepass <JKSキーストアファイルのパスワードを指定します>
    注: -srcstorepassで指定されたパスワードは-deststorepassと同じである必要があります。
    例: keytool -importkeystore -srckeystore samplekeystore.p12 -srcstoretype pkcs12 -srcstorepass PKCSKeyStorePassword -destkeystore keystore -deststoretype JKS -deststorepass PKCSKeyStorePassword
    この例では、samplekeystoreという名前とPKCSKeyStorePasswordというパスワードでキーストアファイルが生成されます。

一方向または双方向のセキュアな通信の設定

接続は、一方向または双方向SSL用に設定できます。

一方向SSL用の接続の設定

接続プロパティの[トラストストアファイル名]フィールドと[トラストストアのパスワード]フィールドで、トラストファイルの名前とトラストストアのパスワードを指定することができます。または、Secure AgentプロパティのJVMオプションでトラストストアファイル名とトラストストアパスワードを設定することもできます。
  1. 1[管理] > [ランタイム環境]をクリックして、エージェントを選択します。
  2. 2[システム構成の詳細][タイプ]で[DTM]を選択します。
  3. 3次のJVMオプションを追加します。

双方向SSL用の接続の設定

接続プロパティ[キーストアファイル名]および[キーストアのパスワード]で、キーファイルの名前とキーストアのパスワードを指定することができます。または、Secure AgentプロパティのJVMオプションでキーストアファイルとキーストアパスワードを設定することもできます。
双方向のSSLを使用するには、最初に一方向SSLの手順を実行してから、次の手順を実行して双方向SSLを設定する必要があります。
  1. 1[管理] > [ランタイム環境]をクリックして、エージェントを選択します。
  2. 2[システム構成の詳細][タイプ]で[DTM]を選択します。
  3. 3次のJVMオプションを追加します。

サーバーレスランタイム環境での安全な通信

サーバーレスランタイム環境を使用している場合は、TLS認証を設定すると、REST APIとの安全な一方向または双方向通信を確立できます。
証明書が.jks形式であることを確認してください。
サーバーレスランタイム環境を使用して安全なREST V2接続を設定するには、次の前提条件タスクを完了して、TLS証明書をサーバーレスランタイムの場所に追加します。
  1. 1AWSのサーバーレスエージェント設定用に次の構造を作成します:
  2. <Supplementary file location>/serverless_agent_config
  3. 2AWSアカウントの次の場所にあるAmazon S3バケットに、一方向の安全な通信の場合はトラストストア証明書を追加し、双方向の安全な通信の場合はトラストストア証明書とキーストア証明書を追加します:
  4. <補足ファイルの場所>/serverless_agent_config/SSL
  5. 3次のコードスニペットをテキストエディタにコピーします。
  6. version: 1
    agent:
    agentAutoApply:
    general:
    sslStore:
    - fileCopy:
    sourcePath: SSL/<RESTV2_trustStore_cert_name>.jks
    - fileCopy:
    sourcePath: SSL/<RESTV2_keyStore_cert_name>.jks
    ここで、ソースパスはAWSの証明書ファイルのディレクトリです。
  7. 4構文とインデントが有効であることを確認してから、ファイルをserverlessUserAgentConfig.ymlとして次のAWSの場所に保存します。
  8. <Supplementary file location>/serverless_agent_config
    .ymlファイルが実行されると、SSL証明書がAWSの場所からサーバーレスエージェントディレクトリにコピーされます。
  9. 5REST V2接続プロパティの[トラストストアファイルパス]フィールドと[キーストアファイルパス]フィールドで、サーバーレスエージェントディレクトリ内の次の証明書パスを指定します:
  10. /home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks

サーバーレスランタイム環境のSwagger仕様ファイル

サーバーレスランタイム環境でSwaggerファイルを設定するには、前提条件を必ず満たすようにしてください。
サーバーレスランタイム環境では、次のいずれかの方法でSwaggerファイルを設定することができます。
サーバーレスランタイム環境でSwaggerファイルを設定するには、次の前提条件のタスクを完了して、Swaggerファイルをサーバーレスランタイムの場所に追加します。
  1. 1AWSまたはAzureのサーバーレスエージェント設定用に次の構造を作成します:
  2. <Supplementary file location>/serverless_agent_config
  3. 2AWSまたはAzureアカウントの次の場所にあるAmazon S3バケットあるいはAzureコンテナにSwagger仕様ファイルを追加します:
  4. <補足ファイルの場所>/serverless_agent_config
    1. a次のコードスニペットをテキストエディタにコピーします。
    2. version: 1
      agent:
      dataIntegrationServer:
      autoApply:
      restv2:
      swaggers:
      - fileCopy:
      sourcePath: restv2/<swagger_file_name1>.json
      - fileCopy:
      sourcePath: restv2/<swagger_file_name2>.json
      ここで、ソースパスはAWSまたはAzureのSwaggerファイルのディレクトリパスです。
  5. 3構文とインデントが有効であることを確認してから、ファイルをserverlessUserAgentConfig.ymlとして次のAWSまたはAzureの場所に保存します:
  6. <Supplementary file location>/serverless_agent_config
    .ymlファイルの実行時に、SSL証明書がAWSまたはAzureの場所からサーバーレスエージェントディレクトリにコピーされます。
  7. 4REST V2接続プロパティで、[Swaggerファイルパス]フィールドのサーバーレスエージェントディレクトリの次のSwaggerパスを指定します:
  8. /home/cldagnt/SystemAgent/serverless/configurations/restv2/<swagger_file_name>.json

ランタイム環境のルールとガイドライン

異なるランタイム環境でタスクを実行する場合は、次のガイドラインを考慮してください。

REST V2接続のルールとガイドライン

Rest V2接続については、次のルールとガイドラインを考慮してください。