4 APIリファレンス: デプロイヤ操作

次の項では、Oracle Virtual Assembly BuilderデプロイヤWebサービスAPIにおけるデプロイヤ操作について説明します(この操作は、そこに含まれるソフトウェア・システムのアセンブリ・アーカイブおよびデプロイメントの側面を管理するために使用されます)。

• 第4.1項「HTTP問合せ文字列におけるパラメータ」

• 第4.2項「AddAssemblyUsers」

• 第4.3項「CreateAssemblyInstance」

• 第4.4項「CreateTags」

• 第4.5項「DeleteAssemblyArchive」

• 第4.6項「DeleteAssemblyInstance」

• 第4.7項「DeleteRequests」

• 第4.8項「DeleteTags」

• 第4.9項「DeployAssemblyInstance」

• 第4.10項「DescribeAssemblyArchives」

• 第4.11項「DescribeApplianceInstances」

• 第4.12項「DescribeAssemblyInstances」

• 第4.13項「DescribeAssemblyUsers」

• 第4.14項「DescribeDeployer」

• 第4.15項「DescribeRegistrations」

• 第4.16項「DescribeRequests」

• 第4.17項「DescribeScalingGroups」

• 第4.18項「DescribeTags」

• 第4.19項「DescribeTargets」

• 第4.20項「DescribeVnets」

• 第4.21項「DownloadAssemblyArchive」

• 第4.22項「DownloadAssemblyMetadata」

• 第4.23「DownloadDeploymentPlan」

• 第4.24項「RedeployAssemblyInstance」

• 第4.25項「RegisterAssemblyArchive」

• 第4.26項「RemoveAssemblyUsers」

• 第4.27項「RestartAssemblyInstance」

• 第4.28項「ScaleAppliance」

• 第4.29項「StartAssemblyInstance」

• 第4.30項「StopAssemblyInstance」

• 第4.31項「UndeployAssemblyInstance」

• 第4.32項「UnregisterAssemblyArchive」

• 第4.33項「UpdateAssemblyArchive」

• 第4.34項「UploadAssemblyArchive」

4.1 HTTP問合せ文字列におけるパラメータ

次の定義は、各操作の「HTTP問合せ文字列における他のパラメータ」の項に示すパラメータに適用されます。

• 1..1 : パラメータは必須で、指定できるのは1回だけです。

• 1..* : パラメータは必須で、複数回指定できます。

• 0..1 : パラメータはオプションで、指定する場合は1回だけ指定できます。

• 0..* : パラメータはオプションで、指定する場合は複数回指定できます。

4.2 AddAssemblyUsers

この操作によって、他のユーザーにアセンブリへのアクセス権が付与されます。この操作は、アセンブリの所有者またはクラウド管理者によってのみ呼出し可能です。所有者は、デプロイヤにアセンブリを最初にアップロードしたユーザーとして定義されます。

アクセス権が付与されるユーザーは、ターゲットにアセンブリを登録でき、アセンブリ・インスタンスを作成できます。

HTTP問合せ文字列における他のパラメータ

user 1..*

assembly.name 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: AddAssemblyUsersResult

4.3 CreateAssemblyInstance

この操作によって、アセンブリにアセンブリ・インスタンスを作成します。

HTTP問合せ文字列における他のパラメータ

assembly.name 1..1

assembly.version 1..1

target 1..1

HTTPメソッド

POST

リクエストのコンテンツ

application/octetstream

プラン・ファイル

動作

同期。

レスポンスのコンテンツ

text/xml要素: CreateAssemblyInstanceResult

4.4 CreateTags

この操作によって、リソースに1つ以上のタグを作成します。

HTTP問合せ文字列における他のパラメータ

tag 1..*

resource.id 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: CreateTagsResult

4.5 DeleteAssemblyArchive

この操作によって、デプロイヤからアセンブリ・アーカイブを削除します。この操作は、アセンブリ・アーカイブの登録がない場合にのみ実行できます。

HTTP問合せ文字列における他のパラメータ

assembly.name 1..1

assembly.version 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DeleteAssemblyArchiveResult

4.6 DeleteAssemblyInstance

この操作によって、アセンブリ・インスタンスを削除します。この操作は、アセンブリがアンデプロイ済の状態である場合にのみ実行可能です。

HTTP問合せ文字列における他のパラメータ

assembly.instance.id

1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DeleteAssemblyInstanceResult

4.7 DeleteRequests

この操作によって、以前に完了したリクエストを1つ以上削除します。

HTTP問合せ文字列における他のパラメータ

request.id 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DeleteRequestsResult

4.8 DeleteTags

この操作によって、リソースのタグを1つ以上削除します。

HTTP問合せ文字列における他のパラメータ

tag 1..*

resource.id 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DeleteTagsResult

4.9 DeployAssemblyInstance

この操作によって、アセンブリ・インスタンスをデプロイします。この操作によって、OVFおよびデプロイメント計画で定義されたデプロイメントの初期インスタンスの作成が編成されます。

HTTP問合せ文字列における他のパラメータ

assembly.instance.id 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

非同期。

レスポンスのコンテンツ

text/xml要素: DeployAssemblyInstanceResult

4.10 DescribeAssemblyArchives

この操作によって、デプロイヤの1つ以上のアセンブリを記述します。

HTTP問合せ文字列における他のパラメータ

assembly.name 1..*

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DescribeAssemblyArchivesResult

4.11 DescribeApplianceInstances

この操作によって、アセンブリの1つ以上のデプロイ済インスタンスを記述します。

HTTP問合せ文字列における他のパラメータ

assembly.instance.id 0..1

appliance.id 0..1

instance.id 0..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DescribeApplianceInstancesResult

4.12 DescribeAssemblyInstances

この操作によって、1つ以上のアセンブリ・インスタンスを記述します。

HTTP問合せ文字列における他のパラメータ

assembly.instance.id 1..*

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DescribeAssemblyInstancesResult

4.13 DescribeAssemblyUsers

この操作によって、アセンブリの1つ以上のユーザーを記述します。

HTTP問合せ文字列における他のパラメータ

assembly.name 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DescribeAssemblyUsersResult

4.14 DescribeDeployer

この操作によって、デプロイヤのバージョン情報が提供されます。

HTTP問合せ文字列における他のパラメータ

N/A

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: RedeployAssemblyInstanceResult

4.15 DescribeRegistrations

この操作によって、1つ以上のアセンブリ登録を記述します。

HTTP問合せ文字列における他のパラメータ

assembly.name 1..1

assembly.version 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DescribeRegistrationsResult

4.16 DescribeRequests

この操作によって、以前に発行された1つ以上のリクエストを記述します。

HTTP問合せ文字列における他のパラメータ

request.id 1..*

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DescribeRequestsResult

4.17 DescribeScalingGroups

この操作によって、1つ以上のスケーリング・グループを記述します。

HTTP問合せ文字列における他のパラメータ

assembly.instance.id 0..*

scalinggroup.id 0..*

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DescribeScalingGroupsResult

4.18 DescribeTags

この操作によって、リソースの1つ以上のタグを記述します。

HTTP問合せ文字列における他のパラメータ

tag 1..*

resource.id 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DescribeTagsResult

4.19 DescribeTargets

この操作によって、1つ以上のアセンブリ・インスタンス・ターゲットを記述します。

HTTP問合せ文字列における他のパラメータ

target 1..*

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DescribeTargetsResult

4.20 DescribeVnets

この操作によって、1つ以上のネットワークを記述します。

HTTP問合せ文字列における他のパラメータ

target 1..1

id 0..*

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: DescribeVnetsResult

4.21 DownloadAssemblyArchive

この操作によって、デプロイヤからアセンブリをダウンロードします。

HTTP問合せ文字列における他のパラメータ

assembly.name 1..1

assembly.version 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

application/octet-stream

アセンブリ・アーカイブ(.ovaファイル)

4.22 DownloadAssemblyMetadata

この操作によって、デプロイヤからアセンブリ・メタデータ記述子をダウンロードします。

HTTP問合せ文字列における他のパラメータ

assembly.name 1..1

assembly.version 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

application/octet-stream

アセンブリ・メタデータ(.ovfファイル)

4.23 DownloadDeploymentPlan

この操作によって、既存のデプロイメントからデプロイメント計画をダウンロードします。

HTTP問合せ文字列における他のパラメータ

assembly.instance.id 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

application/octet-stream

プラン・ファイル

4.24 RedeployAssemblyInstance

この操作によって、アセンブリ・インスタンスを再デプロイします。

HTTP問合せ文字列における他のパラメータ

assembly.instance.id 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

非同期。

レスポンスのコンテンツ

text/xml要素: RedeployAssemblyInstanceResult

4.25 RegisterAssemblyArchive

この操作によって、バックエンド仮想化システム(Oracle VMまたはOracle Exalogic)にアーカイブを登録します。

HTTP問合せ文字列における他のパラメータ

assembly.name 1..1

assembly.version 1..1

assembly.desc 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: RegisterAssemblyArchiveResult

4.26 RemoveAssemblyUsers

この操作によって、アセンブリからユーザーを削除します。

HTTP問合せ文字列における他のパラメータ

user 1..*

assembly.name 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

非同期。

レスポンスのコンテンツ

text/xml要素: RemoveAssemblyUsersResult

4.27 RestartAssemblyInstance

この操作によって、アセンブリ・インスタンスを再起動します。

HTTP問合せ文字列における他のパラメータ

assembly.instance.id 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

非同期。

レスポンスのコンテンツ

text/xml要素: RestartAssemblyInstanceResult

4.28 ScaleAppliance

この操作によって、アプライアンスをスケールします。この操作によって、アプライアンスに必要なインスタンス数を変更し、この新しい数値に応じてインスタンスを作成して開始するか、または停止して破棄します。

HTTP問合せ文字列における他のパラメータ

scalinggroup.id 1..1

target 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

非同期。

レスポンスのコンテンツ

text/xml要素: ScaleApplianceResult

4.29 StartAssemblyInstance

この操作によって、アセンブリ・インスタンスを起動します。

HTTP問合せ文字列における他のパラメータ

deployment.id 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

非同期。

レスポンスのコンテンツ

text/xml要素: StartAssemblyInstanceResult

4.30 StopAssemblyInstance

この操作によって、アセンブリ・インスタンスを停止します。

HTTP問合せ文字列における他のパラメータ

assembly.instance.id 1..1

force 0..1(デフォルトはfalse)

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

非同期。

レスポンスのコンテンツ

text/xml要素: StopAssemblyInstanceResult

4.31 UndeployAssemblyInstance

この操作によって、アセンブリ・インスタンスをアンデプロイします。

HTTP問合せ文字列における他のパラメータ

assembly.instance.id 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: UndeployAssemblyInstanceResult

4.32 UnregisterAssemblyArchive

この操作によって、バックエンド仮想化システム(ターゲット)から、登録のアーティファクトを削除します。ターゲットのこのアセンブリ・アーカイブのアセンブリ・インスタンスが存在しない場合にのみ、この操作を呼び出すことができます。

HTTP問合せ文字列における他のパラメータ

assembly.version 1..1

assembly.name 1..1

target 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: UnregisterAssemblyArchiveResult

4.33 UpdateAssemblyArchive

この操作によって、アセンブリ・アーカイブの記述情報を変更することが許可されます。

注意: 新規バージョンをアップロードするには、UploadAssemblyArchiveを再度呼び出します。

HTTP問合せ文字列における他のパラメータ

assembly.name 1..1

assembly.version 1..1

assembly.desc 1..1

HTTPメソッド

GET

リクエストのコンテンツ

N/A

動作

同期。

レスポンスのコンテンツ

text/xml要素: UpdateAssemblyArchiveResult

4.34 UploadAssemblyArchive

この操作を使用して、クライアントからデプロイヤにアセンブリ操作をアップロードします。デプロイヤはアセンブリ・アーカイブの複数のバージョンを保持するため、同じアセンブリに対しこの操作を複数回呼び出す可能性があります。

HTTP問合せ文字列における他のパラメータ

assembly.name 1..1

HTTPメソッド

POST

リクエストのコンテンツ

application/octetstream

アセンブリ・アーカイブ(.ovaファイル)

動作

同期。

レスポンスのコンテンツ

text/xml要素: UploadAssemblyArchiveResult