前のトピック: WS_API - Web サービス API アプリケーション次のトピック: システム アプリケーション


WS_API_SAMPLE - Web サービス API サンプル アプリケーション

最新バージョン: 1.0.7-1

WS_API_SAMPLE アプリケーションは、CA AppLogic® Web Service API アプリケーション(WS_API)にアクセスするシンプルなポータル アプリケーションを構築する方法についてサンプルを提供します。 このアプリケーションを提供する目的は、CA AppLogic® グリッド上で実行される WS_API アプリケーションのインスタンスに Web API リクエストを発行するポータルおよびアプリケーションの開発者を支援することです。

境界

プロパティ名

タイプ

説明

iface.in

インターフェース

WS_API_SAMPLE ポータルにアクセスできる IP アドレスです。 このプロパティは必須です。

iface.net

インターフェース

WS_API_SAMPLE アプリケーションが HTTP または HTTPS ベースのリクエストを WS_API アプリケーションに発行するために使用される IP アドレスです。 このプロパティは必須です。

iface.vpn

インターフェース

WS_API_SAMPLE アプリケーションが HTTP ベースのリクエストを VPN トンネルを介して WS_API アプリケーションに発行するために使用される IP アドレスです。 このプロパティは必須です。

dns1

IP

ホスト名解決のための DNS サーバの IP アドレス。 このプロパティは必須です。

dns2

IP

ホスト名解決のためのバックアップ DNS サーバの IP アドレス。 デフォルト: 0.0.0.0

api_ports

String

WS_API_SAMPLE アプリケーションがアクセスできるポートのカンマ区切りリスト。 デフォルト: empty

allowed_hosts

String

WS_API_SAMPLE にアクセスできる許可された IP アドレスまたは IP アドレス範囲のリスト(CIDR 形式)。 デフォルト: 0.0.0.0/0 (すべて許可)

重要: iface.vpn、iface.in、iface.net プロパティに設定する IP アドレスは、CA AppLogic® グリッド上で使用可能な IP アドレスである必要があります。 これらは、グリッドのダッシュボード上で、DNS サーバと一緒に検索することができます。

リソース

リソース

最小値

最大値

デフォルト

CPU

0.45

72

1.05

メモリ

704 MB

132 GB

1.343 GB

帯域幅

6 Mbps

12 Gbps

1.151 Gbps

ボリューム

BackupHelper アプリケーションには以下のボリュームがあります。

ボリューム

説明

コンテンツ

スクリプト、ログ、および Web インターフェースが含まれるファイル システム。 このボリュームは変更できません。

概要

WS_API_SAMPLE アプリケーションは、CA AppLogic® グリッド上で実行される WS_API のインスタンスにアクセスするために設定する必要があります。 このアプリケーションを開始する前に、ここでの説明どおりに WS_API アプリケーションのインスタンスを開始します。 次に、WS_API_SAMPLE を設定し、WS_API アプリケーションのインスタンスに設定されたプロパティに関する設定を行います。

WS_API_SAMPLE を設定する方法

  1. アプリケーションの portal ボリュームの bin サブディレクトリ上に存在するポータル スクリプトを編集し、スクリプト内の IP 変数を以下のとおり設定します。
  2. WS_API アプリケーションに HTTP または HTTPS ベースのリクエストを発行するには iface.in に IP アドレスを設定し、VPN トンネル上で HTTP ベースのリクエストを発行するには aux に IP アドレスを設定します。
  3. VDC 情報を編集し、WS_API アプリケーション上の vdcs.conf と一致するようにします。 例:
    # 以下の VDC 情報を編集
    <p>
    <label for="location">Select Location: </label>
    <select name="location">
    <option value="dallas">Dallas, TX, USA</option>
    <option value="sandiego">San Diego, CA, USA</option>
    <option value="japan">Tokyo, Japan</option>
    <option value="netherlands">Amsterdam, Netherlands</option>
    </select>
    </p>
    上記を、WS_API アプリケーション内に設定された VDC に変更する必要があります。 mygrid1 および mygrid2 がそれぞれ Dallas と San Diego で実行される 2 つの VDC である場合、上記の HTML コードを以下のように変更します。 
    # 以下の VDC 情報を編集
    <p>
    <label for="location">Select Location: </label>
    <select name="location">
    <option value="mygrid1">Dallas, TX, USA</option>
    <option value="mygrid2">San Diego, CA, USA</option>
    </select>
    </p>
    

WS_API_SAMPLE は以下のいずれかのモードで動作するように設定できます。

HTTP の使用

このモードでは、ポータルは、標準の HTTP ベースのインターフェースを使用して WS_API アプリケーションのインスタンスへ API リクエストを発行します。
例: curl "http://iface.in/api/v1/app/list?vdc=mygrid1"。

HTTPS の使用

このモードでは、ポータルは、安全な HTTP ベースのインターフェース(つまり HTTPS)を使用して WS_API アプリケーションのインスタンスへ API リクエストを発行します。 そのためには、api_client.pem キーが WS_API_SAMPLE アプリケーションの portal ボリューム上の keys サブディレクトリにコピーされる必要があります。
例: curl -k -E /mnt/fs/keys/api_client.pem "https://iface.in/api/v1/app/list?vdc=mygrid1"。

VPN トンネルの使用

このモードでは、ポータルは、標準の HTTP ベースのインターフェースを使用して、安全な VPN トンネルを介して WS_API アプリケーションのインスタンスへ API リクエストを発行します。 トンネルを作成するには、WS_API アプリケーションのインスタンスの vpn_key ボリュームの server サブディレクトリに生成された client.xxxxxxxxxxxxxxxxxxxxxxxxx.key、client.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.crt、および ca.crt を、WS_API_SAMPLE アプリケーションの vpn_key ボリュームの client サブディレクトリにコピーするだけです。 out_vpn コンポーネントが開始されたら、安全なトンネルが作成されます。
例: curl "http://aux/api/v1/app/list?vdc=mygrid1"

Web ブラウザからポータルにアクセスするには、ブラウザで http://iface.in/api/portal にアクセスします。

アプリケーション アーキテクチャ

CA AppLogic® Web サービス 'WS_API_SAMPLE' アプリケーションのインフラストラクチャを以下に示します。

次のコンポーネントがあります。

API サンプル アプリケーション

メモ

使用するオープン ソース/サードパーティ ソフトウェア

以下のオープン ソース/サードパーティ ソフトウェアが portal ボリュームにインストールされます。

ソフトウェア

バージョン

変更

ライセンス

メモ

JSON

2.15

いいえ

Artistic

該当なし

IPC-Run

0.80

いいえ

GPLv2

該当なし

XML-Simple

2.18

いいえ

Artistic

該当なし

Sort-Naturally

1.02

いいえ

Artistic

該当なし