Version 25.3.9411

• CData API Server インスタンスを起動
• CData API Server へブラウザからアクセス
• 仮想マシン（VM）を管理
  • セキュアシェル（SSH）からインスタンスに接続する
  • CData API Server サービスを制御
  • インストールディレクトリ
    • db フォルダ
    • libs フォルダ
    • アプリケーションディレクトリの設定
  • アプリケーションデータベース
  • ポートとSSL
  • アップグレード
  • 新しいコネクタを追加

CData API Server のAzure Marketplace 版は、API Server があらかじめ設定されたMicrosoft Windows 仮想マシン（VM）で、追加の設定はほとんど必要なくすぐに利用できます。これはAzure Marketplace でCData API Server を検索して入手可能です。

以下のセクションでは、API Server 仮想マシンの作成方法、ブラウザからAPI Server データへのアクセス方法、および仮想マシンの管理方法について説明します。

CData API Server インスタンスを起動

1. Marketplace のCloud Data Pipeline (CData API Server) ページの左ペインから今すぐ入手をクリックします。

2. Azure でこのアプリを作成するダイアログボックスにあるソフトウェアプランリストから、使用するAPI Server エディションを選択します。

   • CData API Server Professional：このプランが提供するコネクション数は10です。Note：Professional プランは、日本語版では提供されていません。

   • CData API Server Enterprise：このプランが提供するコネクション数は20です。

   • CData API Server (BYOL)：このオプションは、最初の2つのオプションが要件を満たさない場合に、ライセンスを持ち込むことができます。このオプションを選択する場合は、CData セールスデスクに連絡して、別途ライセンスを購入する必要があります。

3. 続行をクリックして、Microsoft Azure Web サイトでCData API Serverページを開きます。

4. プランドロップダウンリストで選択したエディションの横にある作成をクリックして、VM を作成します。

5. セキュアシェル（SSH）キーペアを作成してVM に直接接続し、必要に応じてその他の変更を加えます。

6. 確認および作成をクリックして処理を完了します。

CData API Server へブラウザからアクセス

API Server 仮想インスタンスを作成すると、そのインスタンスはAzure ポータルの仮想マシンで利用できるようになります。仮想マシン（VM）が起動したら、次の手順に従います：

1. パブリックIP アドレスを検索してコピーします。そのアドレスを以下に示すようにURL に含め、ブラウザでAPI Server にアクセスします。

         https://PublicIPAddress

2. 次のクレデンシャルを使用してログインします：

   • ユーザー：デフォルトのユーザー名はadmin です。

   • パスワード：パスワードは、VM 名に接頭辞APIServer24: を付けたものです。例えば、VM 名がMyCDataAPIServer の場合、API Server にアクセスするための初期パスワードはAPIServer24:MyCDataAPIServer になります。ログイン後、ブラウザの右上からadmin ユーザーのパスワードを変更できます。

接続を作成セクションを参考に接続を作成し、ジョブを管理します。

仮想マシン（VM）を管理

Azure Marketplace で提供しているCData API Server は、追加設定なしで動作します。ただし、ユーザーはAPI Server を思いどおりにカスタマイズできます。

セキュアシェル（SSH）からインスタンスに接続する

サービスの高度な設定をする際に、Azure API Server インスタンスへのSSH 接続が役立ちます。API Server インスタンスは標準のUbuntu 22 仮想マシン（VM）上に構築されており、メインユーザーはubuntu です。インスタンス起動時に選択したキーペアを使用して、以下に示すようにSSH を介して接続できます：

ssh -i MyKeyPair.pem ubuntu@PublicIPAddress

CData API Server サービスを制御

API Server は、Azure VM デプロイメントで（インプロセスで実行されるのではなく）systemd サービスとして実行されます。サービス定義ファイルは次の場所にあります：

etc/systemd/system/apiserver.service

API Server の停止、起動、および再起動には次のsystemd コマンドを使用します：

sudo systemctl restart apiserver
sudo systemctl stop apiserver
sudo systemctl start apiserver

Note：API Server アプリケーションに変更を加える前に、まずサービスを停止する必要があります。

インストールディレクトリ

すべてのAPI Server の設定とアプリケーションデータは、アプリケーションディレクトリに存在します。デフォルトのアプリケーション ディレクトリ（_ApplicationDirectory_）は次のとおりです：

/opt/apiserver

アプリケーションディレクトリの設定で説明するように、apiserver.properties ファイルでアプリケーションディレクトリのパスを設定できます。

db フォルダ

db フォルダは、デフォルトのDerby データベースのデータベースファイルを含みます。アプリケーションデータベースで説明するように、外部データベースを利用してもアプリケーションデータベースを設定できることに留意してください。

libs フォルダ

libs フォルダは、アプリケーションが外部リソースを読み込む場所であり、外部ドライバをー必要とするコネクタのドライバーのようなものです。このフォルダにJAR ファイルを配置してAPI Server を再起動すると、アプリケーションがこれらのリソースを読み込めるようになります。

アプリケーションディレクトリの設定

_ApplicationDirectory_ の場所は、apiserver.jar ファイルの隣にあるapiserver.properties ファイルで設定できます。

_ApplicationDirectory_ をデフォルト以外の場所に設定するには：

1. apiserver.properties ファイル内で次のスニペットを探します：

   cdata.app.directory =
   

2. 次の例に示すように、_ApplicationDirectory_ の新しい場所へのパスを追加します：

   cdata.app.directory=/mnt/shared/apiserver
   

アプリケーションデータベース

デフォルトでは、API Server は接続、ジョブ、アプリケーション設定、および一般的なアプリケーションログにDerby データベースを使用します。このDerby データベースは、前のセクションで説明したように、アプリケーションディレクトリのdb フォルダにあります。

API Server を設定してMySQL のような外部データベースを使用できます。アプリケーションディレクトリと同様に、apiserver.properties ファイルでアプリケーションデータベースを設定します。

アプリケーションデータベースを設定するには：

1. apiserver.properties ファイル内で次のスニペットを探します：

   cdata.app.db=
   

2. 次の例のように、接続文字列を使用したいターゲットデータベースに設定します：

   cdata.app.db=jdbc:cdata:mysql:Server=MySQLServer;
   Port=3306;Database=mysql;User=User;Password=Password;useconnectionpooling=true
   

3. API Server のサービスを再起動して、以上の手順の変更を有効にします。

ポートとSSL

デフォルトでは、API Server はポート8443でSSL 接続（HTTPS）をリッスンします。アプリケーションは、アクセス許可の制限事項によりデフォルトのHTTPS ポート（443）にバインドできません。そのため、iptables のルールによりポート443からポート8443にトラフィックをリダイレクトします。標準的なHTTPS トラフィックであれば、API Server Web サーバーに到達するためにこれ以上のアクションは必要ありません。

API Server VM には、SSL サーバーをホスティングする際に使用する自己署名証明書が含まれています。証明機関（CA）によって署名された証明書を使用してSSL サーバーをホストしなければならない場合は、直接CA に連絡して証明書を取得する必要があります。

プレーンテキスト / 非SSL ポート（例えば、HTTPS の代わりにHTTP）を追加したい場合は、apiserver.properties ファイルを編集してプレーンテキストのリスナーを有効化する必要があります。アクセス許可の制限事項により、リスナーはポート80に直接バインドできません。そのためポート8181を確立しますが、次の手順でポート80からポート8181にトラフィックを転送するiptables ルールを確立する必要があります：

1. 次のコマンドを実行してAPI Server のサービスを停止します：

   sudo systemctl stop apiserver
   

2. apiserver.properties ファイル内でhttp.port スニペットを探します：

   cdata.http.port=
   

3. ポートを8181に設定して変更を保存します。

4. 以下に示すように、ポート80からポート8181にトラフィックを転送するための新しいiptables ルールを作成します：

   iptables -t nat -I PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 8181 /usr/libexec/iptables/iptables.init save

5. API Server のサービスを再起動して、以上の手順の変更を有効にします。

アップグレード

API Server をアップグレードするには、最新のAPI Server VM の新しいインスタンスを起動する必要があります。新しいインスタンスを起動する前に、古いインスタンスからデータをコピーして、新しいインスタンスでアプリケーションの設定が保持されるようにする必要があります。

API Server には、設定された接続やジョブをアプリケーション上で簡単にエクスポートおよびインポートできる移行ツールが搭載されています。

移行ツールを使用するには：

1. 設定画面で移行タブに移動します。

2. エクスポートをクリックして、すべての設定（接続、ジョブ、ユーザー、および履歴）をZIP ファイルにエクスポートします。

3. 同じ移行タブで、新しいインスタンスに設定をインポートします。

4. インポートをクリックします。

5. 手順2で作成したZIP ファイルを設定します。

新しいコネクタを追加

接続の手順に従ってUI から新しいコネクタを追加できます。ただし、次の手順に従ってインスタンスのコネクタを手動で更新、または追加しなければならない場合があります：

1. SSH を使用してVM に移動します。

2. 次のコマンドを実行してJetty のサービスを停止します：

   sudo systemctl stop apiserver
   

3. 新しいコマンドプロンプトを開き、次のscp コマンドを使用してコネクタをインスタンスにコピーします：

   scp -i ./FolderPath/MyKeyPair.pem ./FolderPath/cdata.jdbc.ProviderName.jar ubuntu@InstancePublicDNS:/home/ubuntu/cdata.jdbc.ProviderName.jar
   

4. このコマンドを実行して、コネクタをlibs フォルダにコピーします：

   sudo cp ./home/ubuntu/cdata.jdbc.ProviderName.jar /opt/apiserver/libs/cdata.jdbc.ProviderName.jar
   

5. 次のコマンドを実行してAPI Server のサービスを再起動します：

   sudo systemctl start apiserver