Skip Headers
Oracle® Virtual Assembly Builder Developer's Guide
11g Release 1 (11.1.1.6.2)

Part Number E49282-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

4 API Reference: Deployer Operations

This chapter describes Deployer operations in the Oracle Virtual Assembly Builder Deployer Web Service API which are used to manage assembly archives and deployment aspects of the software system contained therein.

In an Oracle Exalogic environment, you perform deployment operations using the Deployer installed in the Exalogic Control VM, deploying instances of OVAB-generated assemblies in the Exalogic vDC. See "Deploying Assemblies in the Exalogic vDC Using OVAB Deployer" in the Oracle Exalogic Elastic Cloud Administrator's Guide.

This chapter contains the following sections:

4.1 Parameters in HTTP Query String

The following designations apply to parameters in the "Other Parameters in HTTP Query String" sections of each operation:

4.2 AddAssemblyUsers

This operation grants access to an assembly to other users. This operation can only be called by the assembly owner or Cloud Admin. The owner is defined to be the user who first uploaded the assembly to the Deployer.

A user who is granted access may register the assembly with a target and create an assembly instance.

Other Parameters in HTTP Query String

user 1..*

assembly.name 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: AddAssemblyUsersResult

4.3 CreateAssemblyInstance

This operation creates an assembly instance for an assembly.

Other Parameters in HTTP Query String

assembly.name 1..1

assembly.version 1..1

target 1..1

HTTP Method

POST

Request Content

application/octetstream

Plan file

Behavior

Synchronous.

Response Content

text/xml Element: CreateAssemblyInstanceResult

4.4 CreateTags

This operation creates one or more tags for a resource.

Other Parameters in HTTP Query String

tag 1..*

resource.id 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: CreateTagsResult

4.5 DeleteAssemblyArchive

This operation deletes an assembly archive from the Deployer. This operation may only be performed if there are no registrations for the assembly archive.

Other Parameters in HTTP Query String

assembly.name 1..1

assembly.version 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DeleteAssemblyArchiveResult

4.6 DeleteAssemblyInstance

This operation deletes an assembly instance. This operation can only be executed when the assembly is in an undeployed state.

Other Parameters in HTTP Query String

assembly.instance.id

1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DeleteAssemblyInstanceResult

4.7 DeleteRequests

This operation deletes one or more previously completed requests.

Other Parameters in HTTP Query String

request.id 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DeleteRequestsResult

4.8 DeleteTags

This operation deletes one or more tags for a resource.

Other Parameters in HTTP Query String

tag 1..*

resource.id 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DeleteTagsResult

4.9 DeployAssemblyInstance

This operation deploys an assembly instance. This operation orchestrates the creation of the initial instances for the deployment defined in the OVF and deployment plan.

Other Parameters in HTTP Query String

assembly.instance.id 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Asynchronous.

Response Content

text/xml Element: DeployAssemblyInstanceResult

4.10 DescribeAssemblyArchives

This operation describes one or more assemblies in the Deployer.

Other Parameters in HTTP Query String

assembly.name 1..*

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DescribeAssemblyArchivesResult

4.11 DescribeApplianceInstances

This operation describes one or more deployed instances of an assembly.

Other Parameters in HTTP Query String

assembly.instance.id 0..1

appliance.id 0..1

instance.id 0..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DescribeApplianceInstancesResult

4.12 DescribeAssemblyInstances

This operation describes one or more assembly instances.

Other Parameters in HTTP Query String

assembly.instance.id 1..*

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DescribeAssemblyInstancesResult

4.13 DescribeAssemblyUsers

This operation describes one or more users of an assembly.

Other Parameters in HTTP Query String

assembly.name 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DescribeAssemblyUsersResult

4.14 DescribeDeployer

This operation provides version information for the Deployer.

Other Parameters in HTTP Query String

N/A

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: RedeployAssemblyInstanceResult

4.15 DescribeRegistrations

This operation describes one or more assembly registrations.

Other Parameters in HTTP Query String

assembly.name 1..1

assembly.version 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DescribeRegistrationsResult

4.16 DescribeRequests

This operation describes one or more previously issued requests.

Other Parameters in HTTP Query String

request.id 1..*

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DescribeRequestsResult

4.17 DescribeScalingGroups

This operation describes one or more scaling groups.

Other Parameters in HTTP Query String

assembly.instance.id 0..*

scalinggroup.id 0..*

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DescribeScalingGroupsResult

4.18 DescribeTags

This operation describes one or more tags for a resource.

Other Parameters in HTTP Query String

tag 1..*

resource.id 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DescribeTagsResult

4.19 DescribeTargets

This operation describes one or more assembly instance targets.

Other Parameters in HTTP Query String

target 1..*

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DescribeTargetsResult

4.20 DescribeVnets

This operation describes one or more networks.

Other Parameters in HTTP Query String

target 1..1

id 0..*

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: DescribeVnetsResult

4.21 DownloadAssemblyArchive

This operation downloads an assembly from the Deployer.

Other Parameters in HTTP Query String

assembly.name 1..1

assembly.version 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

application/octet-stream

assembly archive (.ova file)

4.22 DownloadAssemblyMetadata

This operation downloads assembly metadata descriptor from the Deployer.

Other Parameters in HTTP Query String

assembly.name 1..1

assembly.version 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

application/octet-stream

assembly metadata (.ovf file)

4.23 RedeployAssemblyInstance

This operation redeploys an assembly instance.

Other Parameters in HTTP Query String

assembly.instance.id 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Asynchronous.

Response Content

text/xml Element: RedeployAssemblyInstanceResult

4.24 RegisterAssemblyArchive

This operation registers the archive with the backend virtualization system (Oracle VM or Oracle Exalogic).

Other Parameters in HTTP Query String

assembly.name 1..1

assembly.version 1..1

assembly.desc 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: RegisterAssemblyArchiveResult

4.25 RemoveAssemblyUsers

This operation removes users from an assembly.

Other Parameters in HTTP Query String

user 1..*

assembly.name 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Asynchronous.

Response Content

text/xml Element: RemoveAssemblyUsersResult

4.26 RestartAssemblyInstance

This operation restarts an assembly instance.

Other Parameters in HTTP Query String

assembly.instance.id 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Asynchronous.

Response Content

text/xml Element: RestartAssemblyInstanceResult

4.27 ScaleAppliance

This operation scales an appliance. This operation changes the number of instances desired for an appliance and will lead to instances being created and started or stopped and destroyed depending on the new number.

Other Parameters in HTTP Query String

scalinggroup.id 1..1

target 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Asynchronous.

Response Content

text/xml Element: ScaleApplianceResult

4.28 StartAssemblyInstance

This operation starts an assembly instance.

Other Parameters in HTTP Query String

deployment.id 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Asynchronous.

Response Content

text/xml Element: StartAssemblyInstanceResult

4.29 StopAssemblyInstance

This operation stops an assembly instance.

Other Parameters in HTTP Query String

assembly.instance.id 1..1

force 0..1 (default is false)

HTTP Method

GET

Request Content

N/A

Behavior

Asynchronous.

Response Content

text/xml Element: StopAssemblyInstanceResult

4.30 UndeployAssemblyInstance

This operation undeploys the assembly instance.

Other Parameters in HTTP Query String

assembly.instance.id 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Asynchronous.

Response Content

text/xml Element: UndeployAssemblyInstanceResult

4.31 UnregisterAssemblyArchive

This operation removes the registration artifacts from the backend virtualization system (target). This operation can only be called if there are no assembly instances for this assembly archive in the target.

Other Parameters in HTTP Query String

assembly.version 1..1

assembly.name 1..1

target 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: UnregisterAssemblyArchiveResult

4.32 UpdateAssemblyArchive

This operation allows you to modify the description information for the assembly archive.

Note:

To upload a new version, you would call UploadAssemblyArchive again.

Other Parameters in HTTP Query String

assembly.name 1..1

assembly.version 1..1

assembly.desc 1..1

HTTP Method

GET

Request Content

N/A

Behavior

Synchronous.

Response Content

text/xml Element: UpdateAssemblyArchiveResult

4.33 UploadAssemblyArchive

This operation is used to upload an assembly operation from a client to the Deployer. The Deployer will keep multiple versions of an assembly archive so you may call this operation more than once for the same assembly.

Other Parameters in HTTP Query String

assembly.name 1..1

HTTP Method

POST

Request Content

application/octetstream

Assembly archive (.ova file)

Behavior

Synchronous.

Response Content

text/xml Element: UploadAssemblyArchiveResult