API Webサービス

2.1 操作

Oracle Virtual Assembly Builderデプロイヤによって、WebサービスおよびCLI操作で使用される論理操作が提供されます。一部の操作は非同期であり、これらの操作をdescribeRequests操作で追跡できます。

操作に関する包括的なAPIリファレンスは、次の章に記載されています。

2.2 管理操作

Oracle Virtual Assembly Builderデプロイヤによって、ターゲットを構成するための論理的な管理操作が提供され、この操作では、仮想化環境におけるプールを参照します。これらの操作はすべて同期がとられます。

仮想化環境の動作およびその環境との対話方法の違いによって、このような構成には2つの手順が含まれます。

CreateTarget操作を使用したターゲットの作成。この手順は、Oracle VMの場合にのみ必要です(Oracle Exalogicには事前構成済の単一のターゲットが付属あるため)。
AddTargetUserを使用したターゲットに対する指定ユーザーの構成情報の追加。詳細は、第3章「APIリファレンス: 管理操作」の第3.3項「AddTargetUser」を参照してください。

ユーザーを追加するための操作は、これらの管理操作では提供されません。これらの操作は、このような操作を行う権限のあるセキュリティ管理者がLDAPサーバーに対して直接実行するものとされるためです。

2.3 使用方法およびライフサイクル

Oracle Virtual Assembly Builderデプロイヤを使用する際の最初の操作は、uploadAssemblyArchive操作を使用してデプロイヤのリポジトリにアセンブリ・アーカイブをアップロードすることです。

registerAssemblyArchive操作を使用して、アップロード済のアセンブリ・アーカイブを1つ以上のターゲットに登録できます。登録の詳細は、ターゲット・タイプごとに異なります。Oracle VMの場合は、デプロイヤへのアセンブリ・アーカイブのアップロード、Oracle VMシステム内のターゲットへのテンプレートの登録が含まれます。

ターゲットにアセンブリ・アーカイブが登録された後、createAssemblyInstance操作を使用して、その登録に1つ以上のアセンブリ・インスタンスを作成できます。アセンブリ・インスタンスは、アセンブリ・アーカイブによって定義されたアセンブリのVMインスタンスのライフサイクルを管理するために使用されるコンテキストです。アセンブリ・インスタンスの作成時に、デプロイメント計画(アセンブリ・インスタンス経由で管理されるアセンブリの環境に固有の詳細を定義するもの)が提供される必要があります。

アセンブリ・アーカイブのアセンブリ・インスタンスが作成されると、デプロイメント操作を開始できます。デプロイメント中に、アセンブリ・アーカイブによって定義されたアセンブリの初期インスタンスが作成され、起動されます。これが行われると、デプロイヤは、インスタンスの初期化スクリプトに埋め込まれた再構成ロジックと対話します(このロジックは、ネットワークおよびマウント済のディスク・ボリュームを構成し、その環境用にアプリケーション・スタックも構成します)。これらの対話によって、アプリケーション・スタックの起動時に作成されるインスタンス間の接続が構成されます。

アセンブリ・インスタンスがデプロイされると、アセンブリ内のアプライアンスで実行中のインスタンスの数を増減させるscaleなど、その他の多数のライフサイクル操作を実行中のシステムに適用できます。デプロイメントのすべてのインスタンスを停止および起動する操作もあり、この操作は、アプリケーションをオフラインにしたりオンラインに戻したりするために使用されます。

2.4 管理Webサービス

Webサービスに対する操作は、デプロイヤのコンテキスト・パスにHTTPリクエストをポストすることによって行われます。このリクエストには、操作に対する引数を定義するゼロ個以上のリクエスト・パラメータが続くアクションを定義するリクエスト・パラメータが含まれます。詳細は、次の第2.5.2項「問合せ文字列のパターン」を参照してください。

2.4.1 コンテキスト・パス

管理Webサービスのコンテキスト・パスは、/ovab/adminです。

2.4.2 問合せ文字列のパターン

アクション= action&param1=value&param2=value...

値の配列の場合は、問合せ文字列で同じパラメータ名を複数回使用します。次に例を示します。

アクション= action&param1=value&param2=value&param2=value...

2.4.3 アクション

第3章「APIリファレンス: 管理操作」では、管理Webサービスによって公開されるすべての操作が説明されています。レスポンスのコンテンツの列に含まれる型の詳細は、付録A「Webサービス・スキーマ」に示すスキーマで参照できる場合があります。

2.4.4 エラー処理

表2-1に、Webサービスに対して実行されるエラー処理の方法を示しています。

表2-1 Webサービスのエラー処理

エラーに対する責任	HTTPステータス・コード	レスポンスのコンテンツのXML要素
ユーザー	4xx	ErrorResult (type=USER)
サービス	5xx	ErrorResult (type=SERVICE)

注意:

エラーが発生した場合、レスポンスにコンテンツがない可能性があります(ErrorResult)。HTTPステータス・コードがサーブレット・コンテナによって生成された場合、レスポンスのコンテンツはなくなります。HTTPレスポンスがOracle Virtual Assembly Builderデプロイヤによって生成されと、予期しないサービス・エラーが発生した場合を除いて、通常はレスポンスにコンテンツが存在します。

2.4.5 XMLスキーマ

付録A「Webサービス・スキーマ」で、Webサービスのスキーマを参照できます。このスキーマには、前述のアクションの表に含まれるレスポンスのコンテンツ項目の定義が含まれます。

2.5 デプロイヤWebサービス

Webサービスに対する操作は、デプロイヤのコンテキスト・パスにHTTPリクエストをポストすることによって行われます。このリクエストには、操作に対する引数を定義するゼロ個以上のリクエスト・パラメータが続くアクションを定義するリクエスト・パラメータが含まれます。詳細は、次の第2.5.2項「問合せ文字列のパターン」を参照してください。

第2.1項「操作」に示すとおり、一部の操作で非同期アクションが開始される場合があります。Webサービスによって公開される操作は、前述の論理操作の説明で示したものと同じです。

2.5.1 コンテキスト・パス

デプロイヤWebサービスのコンテキスト・パスは、/ovab/deployerです。

2.5.2 問合せ文字列のパターン