Oracle® Fusion Middleware Oracle Virtual Assembly Builderアプリケーションおよびイントロスペクション・プラグインの開発 12c (12.1.2) E47992-01 |
|
前 |
次 |
次の項では、Oracle Virtual Assembly BuilderデプロイヤWebサービスAPIにおけるデプロイヤ操作について説明します(この操作は、そこに含まれるソフトウェア・システムのアセンブリ・アーカイブおよびデプロイメントの側面を管理するために使用されます)。
次の定義は、各操作の「HTTP問合せ文字列における他のパラメータ」の項に示すパラメータに適用されます。
1..1 : パラメータは必須で、指定できるのは1回だけです。
1..* : パラメータは必須で、複数回指定できます。
0..1 : パラメータはオプションで、指定する場合は1回だけ指定できます。
0..* : パラメータはオプションで、指定する場合は複数回指定できます。
この操作によって、他のユーザーにアセンブリへのアクセス権が付与されます。この操作は、アセンブリの所有者またはクラウド管理者によってのみ呼出し可能です。所有者は、デプロイヤにアセンブリを最初にアップロードしたユーザーとして定義されます。
アクセス権が付与されるユーザーは、ターゲットにアセンブリを登録でき、アセンブリ・インスタンスを作成できます。
HTTP問合せ文字列における他のパラメータ
user 1..*
assembly.name 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: AddAssemblyUsersResult
この操作によって、アセンブリにアセンブリ・インスタンスを作成します。
HTTP問合せ文字列における他のパラメータ
assembly.name 1..1
assembly.version 1..1
target 1..1
plan.name 0..1
HTTPメソッド
POST
リクエスト・コンテキスト
application/octetstream
プラン・ファイル
動作
同期。
レスポンスのコンテンツ
text/xml要素: CreateAssemblyInstanceResult
この操作によって、リソースに1つ以上のタグを作成します。
HTTP問合せ文字列における他のパラメータ
tag 1..*
resource.id 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: CreateTagsResult
この操作によって、デプロイヤからアセンブリ・アーカイブを削除します。この操作は、アセンブリ・アーカイブの登録がない場合にのみ実行できます。
HTTP問合せ文字列における他のパラメータ
assembly.name 1..1
assembly.version 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DeleteAssemblyArchiveResult
この操作によって、アセンブリ・インスタンスを削除します。この操作は、アセンブリがアンデプロイ済の状態である場合にのみ実行可能です。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id
1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DeleteAssemblyInstanceResult
この操作によってアセンブリのバージョンに関連付けられたリソースを削除します。
HTTP問合せ文字列における他のパラメータ
assembly.name
1..1
assembly.version
1..1
file
0..1 (削除されるリソース・パスのリスト。未設定の場合は、すべてのリソースが削除されます)。
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DeleteAssemblyResourcesResult
この操作によってデプロイヤ・リポジトリからデプロイ・プランを削除します(注意: 使用中のプランを削除しようとするとこの操作は失敗します)。
HTTP問合せ文字列における他のパラメータ
assembly.name
1..1
assembly.version
1..1
assembly.plan.name
1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DeleteDeploymentPlanResult
この操作によってシステム内のログ・イベントを削除します。パラメータを何も指定しないと、すべてのイベントが削除されます。
HTTP問合せ文字列における他のパラメータ
event.type 0..1
user 0..1
assembly.instance.id 0..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DeleteLogEventsResult
この操作によって、以前に完了したリクエストを1つ以上削除します。
HTTP問合せ文字列における他のパラメータ
request.id 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DeleteRequestsResult
この操作によって、リソースのタグを1つ以上削除します。
HTTP問合せ文字列における他のパラメータ
tag 1..*
resource.id 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DeleteTagsResult
この操作によって、アセンブリ・インスタンスをデプロイします。この操作によって、OVFおよびデプロイメント計画で定義されたデプロイメントの初期インスタンスの作成が編成されます。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
非同期。
レスポンスのコンテンツ
text/xml要素: DeployAssemblyInstanceResult
この操作によってデプロイヤ・リポジトリに1つ以上のアセンブリ・アーカイブを記述します。
HTTP問合せ文字列における他のパラメータ
assembly.name 1..*
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeAssemblyArchivesResult
この操作によって、アセンブリの1つ以上のデプロイ済インスタンスを記述します。
デプロイ済インスタンスのIDと状態に関する情報に加え、レスポンス・コンテンツにはアプライアンス・インスタンスの各ネットワーク・インタフェースの名前、IPアドレス、ネットワーク名およびパブリック/プライベート・ステータスを示す要素のリストが含まれます。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id 0..1
appliance.id 0..1
instance.id 0..1
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeApplianceInstancesResult
この操作によって、1つ以上のアセンブリ・インスタンスを記述します。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id 1..*
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeAssemblyInstancesResult
この操作によってアセンブリに関連付けられたリソースを記述します。
HTTP問合せ文字列における他のパラメータ
assembly.name
1..1
assembly.version
1..1
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeAssemblyResourcesResult
この操作によって、アセンブリの1つ以上のユーザーを記述します。
HTTP問合せ文字列における他のパラメータ
assembly.name 1..1
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeAssemblyUsersResult
この操作によって、デプロイヤのバージョン情報が提供されます。
HTTP問合せ文字列における他のパラメータ
N/A
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: RedeployAssemblyInstanceResult
この操作はシステム内にログ・イベントを記述します。パラメータを何も指定しないと、すべてのイベントが記述され、それ以外の場合は、結果は指定したパラメータによってフィルタされます。
デプロイヤはOVAB管理者が表示するための特定のVMライフサイクル・イベントを追跡します。イベントは次のとおりです。
VM_CREATE
VM_START
VM_STOP
VM DESTROY
次の情報がVM_START、VM_STOPおよびVM_DESTROYのイベントごとに格納されます。
ユーザー
タイムスタンプ
デプロイメントID
アセンブリ名
アプライアンス・パス
アプライアンス・インスタンス・インデックス
次の情報がVM_CREATE操作ごとに格納されます。
CPUの要件
メモリーの要件
ディスクの要件
HTTP問合せ文字列における他のパラメータ
user 0..1
assembly.instance.id 0..1
after.time 0..1
before.time 0..1
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeLogEventsResult
この操作によって、1つ以上のアセンブリ登録を記述します。
HTTP問合せ文字列における他のパラメータ
assembly.name 1..1
assembly.version 1..1
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeRegistrationsResult
この操作によって、以前に発行された1つ以上のリクエストを記述します。
HTTP問合せ文字列における他のパラメータ
request.id 1..*
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeRequestsResult
この操作によって、1つ以上のスケーリング・グループを記述します。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id 0..*
scalinggroup.id 0..*
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeScalingGroupsResult
この操作によって、リソースの1つ以上のタグを記述します。
HTTP問合せ文字列における他のパラメータ
tag 1..*
resource.id 1..1
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeTagsResult
この操作によって、1つ以上のアセンブリ・インスタンス・ターゲットを記述します。
HTTP問合せ文字列における他のパラメータ
target 1..*
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeTargetsResult
この操作によって、1つ以上のネットワークを記述します。
HTTP問合せ文字列における他のパラメータ
target 1..1
id 0..*
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: DescribeVnetsResult
この操作によって、デプロイヤからアセンブリをダウンロードします。
HTTP問合せ文字列における他のパラメータ
assembly.name 1..1
assembly.version 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
application/octet-stream
アセンブリ・アーカイブ(.ovaファイル)
この操作によって、デプロイヤからアセンブリ・メタデータ記述子をダウンロードします。
HTTP問合せ文字列における他のパラメータ
assembly.name 1..1
assembly.version 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
application/octet-stream
アセンブリ・メタデータ(.ovfファイル)
この操作によってデプロイヤ・リポジトリからリソースzipファイルをダウンロードします。
HTTP問合せ文字列における他のパラメータ
assembly.name
1..1
assembly.version
1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
application/octet-streamアセンブリ・リソースZipファイル
この操作によって、アセンブリ・インスタンスを再デプロイします。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id
1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
非同期。
レスポンスのコンテンツ
text/xml要素: RedeployAssemblyInstanceResult
この操作によってバックエンド仮想化システム(Oracle VM)にアーカイブを登録します。
HTTP問合せ文字列における他のパラメータ
assembly.name
1..1
assembly.version
1..1
assembly.desc
1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: RegisterAssemblyArchiveResult
この操作によって、アセンブリからユーザーを削除します。
HTTP問合せ文字列における他のパラメータ
user 1..*
assembly.name 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
非同期。
レスポンスのコンテンツ
text/xml要素: RemoveAssemblyUsersResult
この操作によって、アセンブリ・インスタンスを再起動します。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
非同期。
レスポンスのコンテンツ
text/xml要素: RestartAssemblyInstanceResult
この操作によってアセンブリ・インスタンスのすべてのvServerを再開します。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
非同期。
レスポンスのコンテンツ
text/xml要素: ResumeAssemblyInstanceResult
この操作によって、アプライアンスをスケールします。この操作によって、アプライアンスに必要なインスタンス数を変更し、この新しい数値に応じてインスタンスを作成して開始するか、または停止して破棄します。
HTTP問合せ文字列における他のパラメータ
scalinggroup.id 1..1
target 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
非同期。
レスポンスのコンテンツ
text/xml要素: ScaleApplianceResult
この操作によって、アセンブリ・インスタンスを起動します。
HTTP問合せ文字列における他のパラメータ
deployment.id 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
非同期。
レスポンスのコンテンツ
text/xml要素: StartAssemblyInstanceResult
この操作によって、アセンブリ・インスタンスを停止します。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id 1..1
force 0..1(デフォルトはfalse)
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
非同期。
レスポンスのコンテンツ
text/xml要素: StopAssemblyInstanceResult
この操作によってアセンブリ・インスタンスのすべてのvServerを一時停止します。これはOSがシャットダウンされない仮想休止操作です。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
非同期。
レスポンスのコンテンツ
text/xml要素: SuspendAssemblyInstanceResult
この操作によって、アセンブリ・インスタンスをアンデプロイします。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
非同期。
レスポンスのコンテンツ
text/xml要素: UndeployAssemblyInstanceResult
この操作によって、バックエンド仮想化システム(ターゲット)から、登録のアーティファクトを削除します。ターゲットのこのアセンブリ・アーカイブのアセンブリ・インスタンスが存在しない場合にのみ、この操作を呼び出すことができます。
HTTP問合せ文字列における他のパラメータ
assembly.version 1..1
assembly.name 1..1
target 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: UnregisterAssemblyArchiveResult
この操作によって、アセンブリ・アーカイブの記述情報を変更することが許可されます。
注意: 新規バージョンをアップロードするには、 |
HTTP問合せ文字列における他のパラメータ
assembly.name 1..1
assembly.version 1..1
assembly.desc 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
N/A
動作
同期。
レスポンスのコンテンツ
text/xml要素: UpdateAssemblyArchiveResult
この操作を使用して、クライアントからデプロイヤにアセンブリ操作をアップロードします。デプロイヤはアセンブリ・アーカイブの複数のバージョンを保持するため、同じアセンブリに対しこの操作を複数回呼び出す可能性があります。
HTTP問合せ文字列における他のパラメータ
assembly.name 1..1
HTTPメソッド
POST
リクエスト・コンテキスト
application/octetstream
アセンブリ・アーカイブ(.ovaファイル)
動作
同期。
レスポンスのコンテンツ
text/xml要素: UploadAssemblyArchiveResult
この操作によってデプロイヤ・リポジトリにリソースzipファイルをアップロードし、それをアセンブリのバージョンに関連付けます。
通常アセンブリリソースは1つのセットとして処理されリソースは単一の操作でアップロードされます。リソースを置換する必要があった場合はすべてのリソースを削除してから新しいリソース・セットのアップロードでそれらを置換します。これはこれらの操作のデフォルト動作です。
ディスク・イメージでは、すべてのリソースを再アップロードするコストを発生させずに単一のイメージを置換する場合があります。また、スクリプトは一般にアセンブリ自体とは密接に関連していないため、すべてのリソースを再アップロードする必要なくスクリプトを変更または追加する場合があります。
このような理由から、これらの操作にはこれらのシナリオをサポートするためのオプションがあります。DeleteAssemblyResources
操作には、削除するファイルのサブセットを指定できるfiles
オプションがあります。これが指定されていない場合はデフォルト動作によってすべてのリソースが削除されます。files
オプションとUploadAssemblyResources
のappend
オプションは組み合せて使用できます。append
オプションは既存のリソース・セットに追加する手段を提供します。files
オプションを使用してリソースのサブセットを削除し、その後UploadAssemblyResources
のappend
オプションによってそれらのファイルの代替をアップロードすることで、「置換」の概念を実現できます。
HTTP問合せ文字列における他のパラメータ
assembly.name
1..1
assembly.version
1..1
append
0..1 (追加のリソースをアップロードできます。このオプションなしで、2番目のアップロードを実行しようとすると拒否されます)。
HTTPメソッド
POST
リクエスト・コンテキスト
application/octet-streamアセンブリ・リソースzipファイル
動作
同期。
レスポンスのコンテンツ
text/xml要素: UploadAssemblyResourcesResult
この操作によってデプロイヤリポジトリに既存のアセンブリのデプロイメント・プランをアップロードします。デプロイメント・プランを特定のアセンブリのバージョンに関連付けられたデプロイヤ・リポジトリに格納するメカニズムを提供します。以前にアップロードされたデプロイメント・プランを参照するCreateAssemblyInstance
操作に計画名を指定できるため、アセンブリ作成時のプランのアップロードはオプションです。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id
1..1
HTTPメソッド
POST
リクエスト・コンテキスト
application/octet-streamデプロイメント・プランxmlまたはzipストリーム
動作
同期。
レスポンスのコンテンツ
text/xml要素: UploadDeploymentPlanResult
この操作によって、ターゲットのアセンブリ・インスタンスにアセンブリをデプロイするために十分なリソースがあるかどうかをチェックします。次のリソースをチェックします。
メモリーの可用性
ディスクの可用性
ネットワークの可用性。プランに指定された名前のネットワークがターゲットに存在しているかどうかをチェックします。
ValidateAssemblyInstanceResources
はデプロイヤ側のチェックを実行します。同じチェックだが、クライアントに存在するアセンブリ・アーカイブに対してのみ実行するValidateAssemblyArchiveResources
CLI操作もあります。この操作と同等なWebサービスはありません。ValidateAssemblyArchiveResources
はデプロイヤに現在のリソースの可用性を問い合せることで動作し、その後、戻されたデータを使用してクライアントでローカルに検証を実行します。
HTTP問合せ文字列における他のパラメータ
assembly.instance.id 1..1
HTTPメソッド
GET
リクエスト・コンテキスト
N/A
動作
非同期。
レスポンスのコンテンツ
text/xml要素: ValidateAssemblyInstanceResult