The following sections 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:
The following designations apply to parameters in the "Other Parameters in HTTP Query String" sections of each operation:
1..1 : Parameter is required, and can have exactly one occurrence.
1..* : Parameter is required, and can have multiple occurrences.
0..1 : Parameter is optional, and can have exactly one occurrence, if provided.
0..* : Parameter is optional, and can have multiple occurrences, if provided.
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
GET
N/A
Synchronous.
text/xml Element: AddAssemblyUsersResult
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
POST
application/octetstream
Plan file
Synchronous.
text/xml Element: CreateAssemblyInstanceResult
This operation creates one or more tags for a resource.
Other Parameters in HTTP Query String
tag 1..*
resource.id 1..1
GET
N/A
Synchronous.
text/xml Element: CreateTagsResult
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
GET
N/A
Synchronous.
text/xml Element: DeleteAssemblyArchiveResult
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
GET
N/A
Synchronous.
text/xml Element: DeleteAssemblyInstanceResult
This operation deletes one or more previously completed requests.
Other Parameters in HTTP Query String
request.id 1..1
GET
N/A
Synchronous.
text/xml Element: DeleteRequestsResult
This operation deletes one or more tags for a resource.
Other Parameters in HTTP Query String
tag 1..*
resource.id 1..1
GET
N/A
Synchronous.
text/xml Element: DeleteTagsResult
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
GET
N/A
Asynchronous.
text/xml Element: DeployAssemblyInstanceResult
This operation describes one or more assemblies in the Deployer.
Other Parameters in HTTP Query String
assembly.name 1..*
GET
N/A
Synchronous.
text/xml Element: DescribeAssemblyArchivesResult
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
GET
N/A
Synchronous.
text/xml Element: DescribeApplianceInstancesResult
This operation describes one or more assembly instances.
Other Parameters in HTTP Query String
assembly.instance.id 1..*
GET
N/A
Synchronous.
text/xml Element: DescribeAssemblyInstancesResult
This operation describes one or more users of an assembly.
Other Parameters in HTTP Query String
assembly.name 1..1
GET
N/A
Synchronous.
text/xml Element: DescribeAssemblyUsersResult
This operation provides version information for the Deployer.
Other Parameters in HTTP Query String
N/A
GET
N/A
Synchronous.
text/xml Element: RedeployAssemblyInstanceResult
This operation describes one or more assembly registrations.
Other Parameters in HTTP Query String
assembly.name 1..1
assembly.version 1..1
GET
N/A
Synchronous.
text/xml Element: DescribeRegistrationsResult
This operation describes one or more previously issued requests.
Other Parameters in HTTP Query String
request.id 1..*
GET
N/A
Synchronous.
text/xml Element: DescribeRequestsResult
This operation describes one or more scaling groups.
Other Parameters in HTTP Query String
assembly.instance.id 0..*
scalinggroup.id 0..*
GET
N/A
Synchronous.
text/xml Element: DescribeScalingGroupsResult
This operation describes one or more tags for a resource.
Other Parameters in HTTP Query String
tag 1..*
resource.id 1..1
GET
N/A
Synchronous.
text/xml Element: DescribeTagsResult
This operation describes one or more assembly instance targets.
Other Parameters in HTTP Query String
target 1..*
GET
N/A
Synchronous.
text/xml Element: DescribeTargetsResult
This operation describes one or more networks.
Other Parameters in HTTP Query String
target 1..1
id 0..*
GET
N/A
Synchronous.
text/xml Element: DescribeVnetsResult
This operation downloads an assembly from the Deployer.
Other Parameters in HTTP Query String
assembly.name 1..1
assembly.version 1..1
GET
N/A
Synchronous.
application/octet-stream
assembly archive (.ova file)
This operation downloads assembly metadata descriptor from the Deployer.
Other Parameters in HTTP Query String
assembly.name 1..1
assembly.version 1..1
GET
N/A
Synchronous.
application/octet-stream
assembly metadata (.ovf file)
This operation downloads a deployment plan from an existing deployment.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
GET
N/A
Synchronous.
application/octet-stream
Plan file
This operation redeploys an assembly instance.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
GET
N/A
Asynchronous.
text/xml Element: RedeployAssemblyInstanceResult
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
GET
N/A
Synchronous.
text/xml Element: RegisterAssemblyArchiveResult
This operation removes users from an assembly.
Other Parameters in HTTP Query String
user 1..*
assembly.name 1..1
GET
N/A
Asynchronous.
text/xml Element: RemoveAssemblyUsersResult
This operation restarts an assembly instance.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
GET
N/A
Asynchronous.
text/xml Element: RestartAssemblyInstanceResult
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
GET
N/A
Asynchronous.
text/xml Element: ScaleApplianceResult
This operation starts an assembly instance.
Other Parameters in HTTP Query String
deployment.id 1..1
GET
N/A
Asynchronous.
text/xml Element: StartAssemblyInstanceResult
This operation stops an assembly instance.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
force 0..1 (default is false)
GET
N/A
Asynchronous.
text/xml Element: StopAssemblyInstanceResult
This operation undeploys the assembly instance.
Other Parameters in HTTP Query String
assembly.instance.id 1..1
GET
N/A
Synchronous.
text/xml Element: UndeployAssemblyInstanceResult
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
GET
N/A
Synchronous.
text/xml Element: UnregisterAssemblyArchiveResult
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
GET
N/A
Synchronous.
text/xml Element: UpdateAssemblyArchiveResult
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
POST
application/octetstream
Assembly archive (.ova file)
Synchronous.
text/xml Element: UploadAssemblyArchiveResult