1. REST API for Oracle SOA Cloud Service
  2. Tasks
  3. Provision Services

Provision a New Service Instance

post

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances

Provisions a new service instance in a domain.

IP networks: A service instance can be attached to an IP network that is already created in Oracle Compute Cloud Service. If you specify an IP network, when you add an instance to an IP network, the instance is assigned an IP address in the IP subnet that you specify. See Creating an IP Network in Using Oracle Cloud Infrastructure Compute Classic.

IP reservations: A consequence of using an IP network is that the auto-assigned IP address could change each time the service instance is started. To assign fixed public IP addresses to a service instance that is attached to an IP network, you can first create reserved IP addresses, then provision the service instance to use those persistent IP addresses.

Provisioning using an Oracle Cloud Infrastructure (native) database: Once the Oracle Cloud Infrastructure database instance is created, note down the following details of the instance:

  • Database SCAN host name
  • Port
  • Host domain name
In the REST API payload, use these values for connectString. The connect string format for both RAC and non-RAC databases is: "connectString": "//<dbScanHostName>.<dbHostDomainName>:<port>/<PDBname>.<dbHostDomainName>"

For example:

"connectString": "//mydbsystem-scan.mysubnet.testvcn.oraclevcn.com:1521/PDB1.mysubnet.testvcn.oraclevcn.com"

Provisioning using an Autonomous Transaction Processing (ATP) database: If you are using an ATP database, there is no connect string. Your payload must include:

  • "atpDBName": "<atpDBName>"
  • "dbType": "ATP"

For additional notes, see Provision an Oracle SOA Cloud Service Instance Using the REST API in Administering Oracle SOA Cloud Service.

Request

Supported Media Types
Path Parameters
Body ()
Provision Payload
Root Schema : InstanceProvisionPayload
Type: object
Show Source
  • This attribute is available only on Oracle Cloud Infrastructure. It is required along with region and subnet.

    Name of a data center location in the Oracle Cloud Infrastructure region that is specified in region. A region is a localized geographic area, composed of one or more availability domains (data centers).

    The availability domain value format is an account-specific prefix followed by <region>-<ad>. For example, FQCn:US-ASHBURN-AD1 where FQCn is the account-specific prefix.

    The Oracle Database Cloud Service database deployment on Oracle Cloud Infrastructure must be in the same region and virtual cloud network as the Oracle SOA Cloud Service instance you are creating on Oracle Cloud Infrastructure. The service instances do not need to be on the same subnet or availability domain.

    See Regions and Availability Domains in the Oracle Cloud Infrastructure documentation.

  • Name of the Oracle Storage Cloud Service container used to provide storage for your service instance backups. Use the following format to specify the container name: <storageservicename>-<storageidentitydomain>/<containername>

    Notes:

    • Do not use an Oracle Storage Cloud container that you use to back up Oracle SOA Cloud Service instances for any other purpose. For example, do not also use it to back up Oracle Database Cloud - Database as a Service instances. Using the container for multiple purposes can result in billing errors.

    On Oracle Cloud Infrastructure Classic, the object storage container does not have to be created ahead of provisioning your Oracle SOA Cloud Service instance.

    To specify the container (existing or new), use one of the following formats:

    • Storage-<identitydomainid>/<containername>
    • <storageservicename>-<identitydomainid>/<containername>
    • https://foo.storage.oraclecloud.com/v1/MyService-bar/MyContainer
    The format to use to specify the container name depends on the URL of your Oracle Cloud Infrastructure Object Storage Classic account. To identify the URL of your account, see Finding the REST Endpoint URL for Your Service Instance in Using Oracle Cloud Infrastructure Object Storage Classic.

    On Oracle Cloud Infrastructure, the object storage bucket must be created ahead of provisioning your Oracle SOA Cloud Service instance. Do not use the same bucket for each service instance. Certain prerequisites must be satisfied when you create the bucket. See Prerequisites for Oracle Platform Services on Oracle Cloud Infrastructure in the Oracle Cloud Infrastructure documentation. Then use the following URL form to specify the bucket:

    https://swiftobjectstorage.<region>.oraclecloud.com/v1/<ObjectStorageNamespace>/<container>

    For example:

    https://swiftobjectstorage.us-phoenix-1.oraclecloud.com/v1/acme/mycontainer

    See Object Storage Service API in the Oracle Cloud Infrastructure documentation.

  • This attribute is not applicable when provisioning an Oracle SOA Cloud Service instance in Oracle Cloud Infrastructure.

    Flag that specifies whether to create (true) or not create (false) the object storage container if the name specified in cloudStorageContainer does not exist. The default is false.

  • Password for the Oracle Storage Cloud Service administrator.
  • Username for the Oracle Storage Cloud Service administrator.
  • components
  • The Edition Value :SUITE
  • Default Value: false
    This is optional. This is to enable the B2B adapter for EDI. This can be enabled only for B2B topologies. This is available for UCM accounts.
  • This attribute is not relevant when provisioning an Oracle SOA Cloud Service instance in Oracle Cloud Infrastructure.

    Flag that specifies whether to enable (true) or disable (false) the access rules that control external communication to the WebLogic Server Administration Console, Fusion Middleware Control, and Load Balancer Console. The default value is false.

    If you do not set it to true, after the service instance is created, you have to explicitly enable the rules for the administration consoles before you can gain access to the consoles. See Update an Access Rule.

    Note:On Oracle Cloud Infrastructure, the security rule that controls access to the WebLogic Server Administration Console and other consoles is enabled by default. You cannot disable it during provisioning.

  • Default Value: false
    Indicates whether to enable (true) or disable (false) notifications by email.

    If this property is set to true, you must specify a value in notificationEmail.

    Currently, notifications are sent only when service instance provisioning is successful or not successful.

  • This is optional. This attribute is only applicable to accounts where regions are supported. Ignore this field if not using IP Networks.

    This attribute is not applicable when provisioning Oracle SOA Cloud Service instances in Oracle Cloud Infrastructure.

    The three-part name of a custom IP network to use. For example:

    /Compute-exampleidentitydomain/username@companyname.com/ipnet-1

    A region name must be specified in order to use ipNetwork. Only those IP networks created in the specified region can be used.

    If using an IP network, note that the dbServiceName for the service instance should be attached to the same ipNetwork. If your Oracle SOA Cloud Service and Oracle Database Cloud Service are attached to different IP networks, then the two IP networks must be connected to the same IP network exchange. Access rules required for the communication between the Oracle SOA Cloud Service instance and Oracle Database Cloud Service database deployment are created automatically.

    See Creating an IP Network in Using Oracle Cloud Infrastructure Compute Classic.

    On Oracle Cloud Machine, ipNetwork cannot be used with ipReservations.

  • Default Value: true
    Flag that specifies whether to apply an existing on-premises license for Oracle WebLogic Server (true) to the new Oracle SOA Cloud Service instance you are provisioning. A Universal Credits subscription is required in order to use existing licenses. BYOL instances are billed at a lower rate than license-included instances.

    On Oracle Cloud at Customer: Default value is false.

    On Oracle Cloud Infrastructure and Oracle Cloud Infrastructure Classic:

    • If the Oracle Cloud account does not have BYOL entitlements, the default value is false. You cannot change it to true. A validation error will occur if you try to provision a service instance without any BYOL entitlements.
    • If the Cloud account only has BYOL entitlements, the default value is true. You cannot change it to false.
    • If the Cloud account has a mix of BYOL entitlements and non-BYOL resources, the default value is true. You can, however, change it to false to provision a service instance without using a BYOL entitlement.

    See Frequently Asked Questions: Oracle BYOL to PaaS. For the processor conversion ratios and license requirements, refer to the document titled Oracle PaaS and IaaS Universal Credits Service Descriptions.

  • Default Value: NONE
    If using an OTD load balancer, set this property to OTD.
  • This describes the Billing Frequency. Valid values include:
    • HOURLY - This is applicable for new Universal Credits Model (UCM) accounts. Pay only for the number of hours used during your billing period. This is the default.
    • MONTHLY - This is applicable for the existing accounts. Pay one price for the full month irrespective of the number of hours used.
  • The email to which notifications will be sent. To receive notifications, enableNotification must be set to true.
  • Default Value: false
    Flag that specifies whether to enable or add the load balancer to the pod during provisioning.

    The OTD component should be provided only if provisionOTD is set to true.

  • Topology Name. Valid values include:
    • mft - MFT (Managed File Transfer) Topology
    • soaosbb2b - SOA, OSB and B2B Topologies
  • This attribute is only applicable to accounts where regions are supported, including accounts on Oracle Cloud Infrastructure. Ignore this field if not using IP Networks.

    Name of the region where the Oracle SOA Cloud Service instance is to be provisioned. For example:

    uscom-central-1

    If no region name is specified, the service instance is provisioned in the same compute site as the site of the Oracle Database Cloud Service database deployment specified in dbServiceName.

    If a region name is specified, note that the dbServiceName for this service instance must be one that is provisioned in the same region.

    A region name must be specified if you want to use ipReservations or ipNetwork.

    An Oracle Cloud Infrastructure region such as us-phoenix-1 must be specified to provision your service instance on Oracle Cloud Infrastructure host resources.

    Note the following when provisioning in Oracle Cloud Infrastructure:

    • An availability domain must also be specified using availabilityDomain. See Regions and Availability Domains in the Oracle Cloud Infrastructure documentation.
    • A subnet must also be specified using subnet. See VCNs and Subnets in the Oracle Cloud Infrastructure documentation.
    • The Oracle Database Cloud Service database deployment on Oracle Cloud Infrastructure must be in the same region and virtual cloud network as the Oracle SOA Cloud Service instance you are creating on Oracle Cloud Infrastructure. The service instances do not need to be on the same subnet or availability domain.
    • Cannot use the WLS component property upperStackProductName.
    • Access rules and IP reservations REST endpoints are not supported.

  • This is optional. Free-form text that provides additional information about the service instance.
  • Service level. Valid values include:
    • PAAS- Production-level service. Supports Oracle SOA Cloud Service instance creation and monitoring; backup and restoration; and scaling. This is the default.
  • Name of Oracle SOA Cloud Service instance. The service name:
    • Must not exceed 50 characters.
    • Must start with a letter.
    • Must contain only letters or numbers.
    • Must not contain any other special characters.
    • Must be unique within the identity domain.

    By default, the names of the domain and cluster in the service instance will be generated from the first eight characters of the service instance name (serviceName), using the following formats, respectively:

    • first8charsOfServiceInstanceName_domain
    • first8charsOfServiceInstanceName_cluster

  • Oracle Fusion Middleware software version. Valid values: 12cRelease213 or 12cRelease214

    Oracle Version 12cRelease212 is out of Premium Support and is deprecated for new instance creation.

  • This attribute is relevant to only Oracle Cloud Infrastructure. Specify the Oracle Cloud Identifier (OCID) of a subnet from a virtual cloud network (VCN) that you had created previously in Oracle Cloud Infrastructure. For the instructions to create a VCN and subnet, see Prerequisites for Oracle Platform Services on Oracle Cloud Infrastructure in the Oracle Cloud Infrastructure documentation.

    The OCID is a unique autogenerated ID. To find out the OCID of a subnet, go to the Oracle Cloud Infrastructure web console, select the Networking tab, click the VCN that your subnet is in, and look for the OCID field under the subnet that you want to use.

    Note: The Oracle Database Cloud Service deployment that you intend to associate with your Oracle SOA Cloud Service instance can be on a different subnet, but it must be in the same region and VCN.

  • This attribute is valid when component type is set to weblogic or otd only.

    Name of the compute SSH key object referring to the public key. You generate an SSH public-private key pair using a standard SSH key generation tool.

Nested Schema : components
Type: object
Show Source
Nested Schema : OTD
Type: object
Provide the OTD parameters below only when provisionOTD is set to true. Do not provide these parameters when provisionOTD is set to false.
Show Source
  • Port for accessing Oracle Traffic Director using HTTP. The default value is 8989.
  • Default Value: false
    Indicates whether OTD is enabled or not.
  • ipReservations
    This attribute is not applicable to Oracle SOA Cloud Service instances on Oracle Cloud Infrastructure.

    Reserved or pre-allocated IP addresses can be assigned to local load balancer nodes.

    A single IP reservation name or two names separated by a comma.

    The number of names in ipReservations must match the number of load balancer nodes you are provisioning.

    Note the difference between accounts where regions are supported and not supported.

    • Where regions are supported: A region name must be specified in order to use ipReservations. Only those reserved IPs created in the specified region can be used.

      See IP Reservations REST Endpoints for information about how to find unused IP reservations and, if needed, create new IP reservations.

    • Where regions are not supported: If you are using an Oracle Database Exadata Cloud Service database deployment with your Oracle SOA Cloud Service instance in an account where regions are not enabled, a region name is not required in order to use ipReservations. However, you must first submit a request to get the IP reservations.

  • Listener port for the local load balancer for accessing deployed applications using HTTP. The default value is 8080.

    This value is overridden by privilegedListenerPort unless its value is set to 0. This value has no effect if the local load balancer is disabled.

  • Flag that specifies whether the non-secure listener port is enabled on the local load balancer. The default value is true.
  • This attribute is valid when component type is set to otd only; it is not valid for weblogic.

    Policy to use for routing requests to the load balancer. Valid policies include:

    • least_connection_count - Passes each new request to the Managed Server with the least number of connections. This policy is useful for smoothing distribution when Managed Servers get bogged down. Managed Servers with greater processing power to handle requests will receive more connections over time. This is the default.
    • least_response_time - Passes each new request to the Managed Server with the fastest response time. This policy is useful when Managed Servers are distributed across networks.
    • round_robin - Passes each new request to the next Managed Server in line, evenly distributing requests across all Managed Servers regardless of the number of connections or response time.

  • Privileged listener port for accessing the deployed applications using HTTP. The default value is 80.

    This value has no effect if the local load balancer is disabled.

    To disable the privileged listener port, set the value to 0. In this case, if the local load balancer is provisioned, the listener port defaults to listenerPort, if specified, or 8080.

  • Privileged listener port for accessing the deployed applications using HTTPS. The default value is 443.

    This value has no effect if the local load balancer is disabled.

    To disable the privileged listener port, set the value to 0. In this case, if the local load balancer is provisioned, the listener port defaults to securedListenerPort, if specified, or 8081.

  • Secured listener port for accessing the deployed applications using HTTPS. The default value is 8081.

    This value is overridden by privilegedSecuredContentPort unless its value is set to 0. This value has no effect if the local load balancer is disabled.

  • Desired OTD compute shape.

    This attribute is required. If you do not want to change the compute shape, set this value to match the current compute shape.

    Valid otd shapes include:

    • oc3: 1 OCPU, 7.5 GB memory
    • oc4: 2 OCPUs, 15 GB memory
    • oc5: 4 OCPUs, 30 GB memory
    • oc6: 8 OCPUs, 60 GB memory

    On Oracle Cloud Infrastructure VM.Standard and BM.Standard shapes are supported. Valid shapes include:

    • VM.Standard1.1: 1 OCPU, 7GB RAM
    • VM.Standard1.2: 2 OCPU, 14GB RAM
    • VM.Standard1.4: 4 OCPU, 28GB RAM
    • VM.Standard1.8: 8 OCPU, 56GB RAM
    • VM.Standard1.16: 16 OCPU, 112GB RAM
    • VM.Standard1.36: 36 OCPU, 256GB RAM
    • VM.Standard2.1: 1 OCPU, 15GB RAM
    • VM.Standard2.2: 2 OCPU, 30GB RAM
    • VM.Standard2.4: 4 OCPU, 60GB RAM
    • VM.Standard2.8: 8 OCPU, 120GB RAM
    • VM.Standard2.16: 16 OCPU, 240GB RAM
    • VM.Standard2.24: 24 OCPU, 320GB RAM
    • BM.Standard1.36: 36 OCPU, 256GB RAM
    • BM.Standard2.52: 52 OCPU, 768GB RAM
    Before proceeding with provisioning, verify that your account has entitlement to the selected VM.Standard and BM.Standard 1.x shapes.

    See Bare Metal Shapes and VM Shapes. Note:Some shapes might not be available in a region.

Nested Schema : WLS
Type: object
Show Source
  • This attribute is valid when component type is set to weblogic only.

    Password for WebLogic Server administrator. The password must meet the following requirements:

    • Starts with a letter
    • Is between 8 and 30 characters long
    • Contains letters, at least one number, and optionally, any number of these special characters: dollar sign ($), pound sign (#), and underscore (_).

  • Port for accessing WebLogic Server using HTTP. The default value is 7001.

    Note that the adminPort, contentPort, securedAdminPort, securedContentPort, and nodeManagerPort values must be unique.

  • This attribute is valid when component type is set to weblogic only.

    Username for the WebLogic Server administrator. The name should be upto 25 characters starting with an alphabet and cannot contain any of the following characters:

    • Tab
    • Brackets
    • Parentheses
    • The following special characters: left angle bracket (<), right angle bracket (>), ampersand (&), pound sign (#), pipe symbol (|), and question mark (?).

  • This attribute is required only if you provision an Oracle SOA Cloud Service instance on Oracle Cloud Infrastructure with the associated infrastructure schema database deployed on Oracle Autonomous Transaction Processing (ATP).

    The value is the name of the infrastructure schema database deployment.

  • This attribute is used when provisioning using native DB only. You must connect to native DB created under same region/AD. During provisioning, connect string is not validated upfront. Request is accepted, but provisioning fails if incorrect details are provided.
  • Port for accessing the deployed applications using HTTP. The default value is 8001.

    This value is overridden by privilegedContentPort unless its value is set to 0.

    If a local load balancer is configured and enabled, this value has no effect.

    Note that the adminPort, contentPort, securedAdminPort, securedContentPort, and nodeManagerPort values must be unique.

  • This attribute is valid when component type is set to weblogic only.

    Username for the Oracle Database Cloud - Database as a Service instance administrator.

    For service instances based on Oracle WebLogic Server 11g (10.3.6), this value must be set to a database user with DBA role. You can use the default user SYSTEM or a user that has been granted the DBA role.

    For service instances based on Oracle WebLogic Server 12c (12.1.3), this value must be set to a database user with SYSDBA system privileges. You can use the default user SYS or a user that has been granted the SYSDBA privilege.

  • This attribute is valid when component type is set to weblogic only.

    Password for the Oracle Database Cloud - Database as a Service instance administrator.

  • This attribute is valid when component type is set to weblogic only. It is used only when provisioning Oracle SOA Cloud Service using a Dbaas instance. Do not use this attribute when using the Oracle Cloud Infrastructure native database to provision Oracle SOA Cloud Service.

    Name of the Oracle Database Cloud - Database as a Service instance. The specified service instance must be running.

    When provisioning a production-level Oracle SOA Cloud Service instance, you must provision a production-level Oracle Database Cloud - Database as a Service instance. You can specify an Oracle SOA Database Service-Virtual Image instance only if you are provisioning an Oracle SOA Cloud Service-Virtual Image instance. If you specify an Oracle Database Cloud Service-Virtual Image, you must specify its connection string using the connectString attribute.

    The required setting of the backup option configured when provisioning the database service instance depends on the service level of your Oracle SOA Cloud Service instance:

    • For Oracle SOA Cloud Service instances, the backup option for the database must be set to Both Cloud Storage and Block Storage.
    • For Oracle SOA Cloud Service-Virtual Image, the backup option can be set to any value.

    Note: To ensure that you can restore the database for an Oracle SOA Cloud Service instance without risking data loss for other service instances, do not use the same Oracle Database Cloud - Database as a Service instance with multiple Oracle SOA Cloud Service instances.

  • Database type. Set to OCINativeDB for an Oracle Cloud Infrastructure database, or ATP for an ATP database.
  • Port for accessing the WebLogic Administration Server using WLST. The default value is 9001.
  • ipReservations
    This attribute is not applicable to Oracle SOA Cloud Service instances on Oracle Cloud Infrastructure.

    Reserved or pre-allocated IP addresses can be assigned to Managed Server nodes in a WebLogic Server application cluster.

    A single IP reservation name or a list of multiple IP reservation names separated by commas.

    If using reserved IPs, all nodes in the cluster must be provisioned with pre-allocated IP addresses. In other words, the number of names in ipReservations must match the number of servers you are provisioning (using managedServerCount or serverCount in clusters array).

    Note the difference between accounts where regions are supported and not supported.

    • Where regions are supported: A region name must be specified in order to use ipReservations. If ipNetwork is also specified, then assignPublicIP must be true to use ipReservations.

      Only those reserved IPs created in the specified region can be used.

      See IP Reservations REST Endpoints for information about how to find unused IP reservations and, if needed, create new IP reservations.

    • Where regions are not supported: When using an Oracle Database Exadata Cloud Service database deployment with your Oracle SOA Cloud Service instance in an account where regions are not enabled, a region name is not required in order to use ipReservations. However, you must first submit a request to get the IP reservations. See the My Oracle Support document titled How to Request Authorized IPs for Provisioning an Oracle SOA Cloud Service with Database Exadata Cloud Service (MOS Note 2163568.1).

  • Default Value: false
    This attribute must be set to true if you provision an Oracle SOA Cloud Service instance with the associated infrastructure schema database deployed on an Oracle Cloud Infrastructure database system that uses Oracle Real Application Clusters (RAC) technology.
  • This attribute is valid when component type is set to weblogic or otd only.

    Number of managed servers. Allowed values are 1, 2, or 4.

  • Port for the Node Manager. The default value is 5556.

    Node Manager is a WebLogic Server utility that enables you to start, shut down, and restart Administration Server and Managed Server instances from a remote location.

    The adminPort, contentPort, securedAdminPort, securedContentPort, and nodeManagerPort values must be unique.

  • Name of the pluggable database for Oracle Database 12c. If not specified, the pluggable database name that was configured when the database was created will be used.
  • Privileged content port for accessing the deployed applications using HTTP. The default value is 80.

    If a local load balancer is configured and enabled, this value has no effect.

    To disable the privileged content port, set the value to 0. In this case, if a local load balancer is not provisioned, the content port defaults to contentPort, if specified, or 8001.

  • Privileged content port for accessing the deployed applications using HTTPS. The default value is 443.

    If a local load balancer is configured and enabled, this value has no effect.

    To disable the privileged listener port, set the value to 0. In this case, if a local load balancer is not provisioned, this value defaults to securedContentPort, if specified, or 8002.

  • Port for accessing the WebLogic Administration Server using HTTPS. The default value is 7002.

    The adminPort, contentPort, securedAdminPort, securedContentPort, and nodeManagerPort values must be unique.

  • Port for accessing the WebLogic Administration Server using HTTPS. The default value is 8002.

    This value is overridden by privilegedSecuredContentPort unless its value is set to 0.

    If a local load balancer is configured and enabled, this value has no effect.

    The adminPort, contentPort, securedAdminPort, securedContentPort, and nodeManagerPort values must be unique.

  • This attribute is valid when component type is set to weblogic or otd only.

    Desired compute shape. A shape defines the number of Oracle Compute Units (OCPUs) and amount of memory (RAM). Valid weblogic shapes include:

    • oc1m: 1 OCPU, 15 GB memory
    • oc2m: 2 OCPUs, 30 GB memory
    • oc3m: 4 OCPUs, 60 GB memory
    • oc4m: 8 OCPUs, 120 GB memory
    • oc5m: 16 OCPUs, 240 GB memory
    See About Machine Images and Shapes in Using Oracle Compute Cloud Service for more information about shapes.

    On Oracle Cloud Infrastructure VM.Standard and BM.Standard shapes are supported. Valid shapes include:

    • VM Standard1.2: 2 OCPU, 14 GB RAM
    • VM Standard1.4: 4 OCPU, 28 GB RAM
    • VM Standard1.8: 8 OCPU, 56 GB RAM
    • VM Standard1.16: 16 OCPU, 112 GB RAM
    • VM.Standard2.1: 1 OCPU, 15GB RAM
    • VM.Standard2.2: 2 OCPU, 30GB RAM
    • VM.Standard2.4: 4 OCPU, 60GB RAM
    • VM.Standard2.8: 8 OCPU, 120GB RAM
    • VM.Standard2.16: 16 OCPU, 240GB RAM
    • VM.Standard2.24: 24 OCPU, 320GB RAM
    • BM Standard1.36: 36 OCPU, 256 GB RAM
    • BM.Standard2.52: 52 OCPU, 768GB RAM
    Before proceeding with provisioning, verify that your account has entitlement to the selected VM.Standard and BM.Standard 1.x shapes.

    See the Bare Metal Shapes and VM Shapes tables of the topic Overview of the Compute Service in the Oracle Cloud Infrastructure documentation.

Nested Schema : ipReservations
Type: array
This attribute is not applicable to Oracle SOA Cloud Service instances on Oracle Cloud Infrastructure.

Reserved or pre-allocated IP addresses can be assigned to local load balancer nodes.

A single IP reservation name or two names separated by a comma.

The number of names in ipReservations must match the number of load balancer nodes you are provisioning.

Note the difference between accounts where regions are supported and not supported.

  • Where regions are supported: A region name must be specified in order to use ipReservations. Only those reserved IPs created in the specified region can be used.

    See IP Reservations REST Endpoints for information about how to find unused IP reservations and, if needed, create new IP reservations.

  • Where regions are not supported: If you are using an Oracle Database Exadata Cloud Service database deployment with your Oracle SOA Cloud Service instance in an account where regions are not enabled, a region name is not required in order to use ipReservations. However, you must first submit a request to get the IP reservations.

Show Source
Nested Schema : ipReservations
Type: array
This attribute is not applicable to Oracle SOA Cloud Service instances on Oracle Cloud Infrastructure.

Reserved or pre-allocated IP addresses can be assigned to Managed Server nodes in a WebLogic Server application cluster.

A single IP reservation name or a list of multiple IP reservation names separated by commas.

If using reserved IPs, all nodes in the cluster must be provisioned with pre-allocated IP addresses. In other words, the number of names in ipReservations must match the number of servers you are provisioning (using managedServerCount or serverCount in clusters array).

Note the difference between accounts where regions are supported and not supported.

  • Where regions are supported: A region name must be specified in order to use ipReservations. If ipNetwork is also specified, then assignPublicIP must be true to use ipReservations.

    Only those reserved IPs created in the specified region can be used.

    See IP Reservations REST Endpoints for information about how to find unused IP reservations and, if needed, create new IP reservations.

  • Where regions are not supported: When using an Oracle Database Exadata Cloud Service database deployment with your Oracle SOA Cloud Service instance in an account where regions are not enabled, a region name is not required in order to use ipReservations. However, you must first submit a request to get the IP reservations. See the My Oracle Support document titled How to Request Authorized IPs for Provisioning an Oracle SOA Cloud Service with Database Exadata Cloud Service (MOS Note 2163568.1).

Show Source
Back to Top

Response

Supported Media Types

202 Response

Accepted.

400 Response

Bad Request. Content-Type: text/plain. Returned if the request payload contains bad or missing details.
Back to Top

Examples

The following example shows how to provision a new service in Oracle SOA Cloud Service instance by submitting a POST request on the REST resource using cURL. For more information, see Use cURL.

cURL Command

curl -i -X POST -u username:Password1! -H "Content-type:application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" -d @create.json https://rest-server_url.com/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/

cURL Command to add BYOL:

curl -i -X POST -u username:password1 -H "Content-type: application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" -d @./addByol.json http://rest-server_url.com/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{instanceName}/config

Example of Request Header

The following example shows the request header.

-u '{userName}:{password}'	
Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json
X-ID-TENANT-NAME: {identityDomainId}
Accept: application/json

Example of Request Body when OTD is provisioned in Oracle Cloud Infrastructure Using a Native Database

The following example shows the request body in JSON format to provision an Oracle SOA Cloud Service instance in Oracle Cloud Infrastructure using an Oracle Cloud Infrastructure (native) database with an OTD load balancer. Note that IP reservations are not applicable when creating service instances in Oracle Cloud Infrastructure.

Note:

cloudStorageContainerAutoGenerate and ipReservations are not available on Oracle Cloud Infrastructure. 

{
	"availabilityDomain":"bcaH:PHX-AD-1",
	"cloudStorageContainer": "<cloudStorageContainerURL>",
	"cloudStorageUser": "<cloudStorageUser>",
	"cloudStoragePassword": "<cloudStoragePassword>", 
	
	"components": {
		"OTD": {
			"haEnabled": "false",
			"listenerPortsEnabled":"true",
			"loadBalancingPolicy": "LEAST_CONNECTION_COUNT",
			"shape": "VM.Standard2.1"
		},			
		"WLS": { 
			"adminUserName": "<adminUserName>",
			"adminPassword": "<adminPassword>", 
			"connectString": "//<dbScanHostName>.<dbHostDomainName>:<port>/<PDBname>.<dbHostDomainName>",
			"dbaName": "<dbaName>", 
			"dbaPassword": "<dbaPassword>", 
			"dbType": "OCINativeDB",
			"isOciRacDb": "false",
			"managedServerCount": "1".
			"pdbServiceName": "PDB1",
			"shape": "VM.Standard2.1"
		} 
	},
	"edition": "SUITE",
	"enableAdapters":"true",
	"enableAdminConsole": "true",
	"isBYOL":"true",
	"loadBalancerOption": "OTD",
	"meteringFrequency": "HOURLY", 
	"provisionOTD": "true", 
	"purchasePack": "soaosbb2b",
	"region": "us-phoenix-1",
	"serviceDescription": "Description For Oracle Cloud Infrastructure",
	"serviceLevel": "PAAS", 
	"serviceName": "<serviceName>", 
	"serviceVersion": "12cRelease214",
	"subnet": "<subnetOCID>",
	"vmPublicKeyText": "<publicKey>" 
}

Example of Request Body when OTD is not provisioned in Oracle Cloud Infrastructure Using a Native Database

The following example shows the request body in JSON format to provision an Oracle SOA Cloud Service instance in Oracle Cloud Infrastructure using an Oracle Cloud Infrastructure (native) database without an OTD load balancer. Note that IP reservations are not applicable when creating service instances in Oracle Cloud Infrastructure.

Note:

cloudStorageContainerAutoGenerate and ipReservations are not available on Oracle Cloud Infrastructure. 

{
	"cloudStorageUser": "<cloudStorageUser>",
	"cloudStoragePassword": "<cloudStoragePassword>",
	"cloudStorageContainer": "<cloudStorageContainerURL>",
	"components": {
		"WLS": {
			"adminUserName": "<adminUserName>",
			"adminPassword": "<adminPassword>",
			"connectString": "//<dbScanHostName>.<dbHostDomainName>:<port>/<PDBname>.<dbHostDomainName>",
			"dbaName": "<dbaName>",
			"dbaPassword": "<dbaPassword>",
			"dbType": "OCINativeDB",
			"isOciRacDb": "false",
			"managedServerCount": "1",
			"pdbServiceName": "PDB1",
			"shape": "VM.Standard2.1"
		}
	},
	"availabilityDomain":"bcaH:PHX-AD-1",
	"edition": "SUITE",
	"enableAdapters": "false",
	"enableAdminConsole": "true",
	"enableNotification": "false",
	"isBYOL": "true",
	"loadBalancerOption": "NONE",
	"meteringFrequency": "HOURLY",
	"purchasePack": "soaosbb2b",
	"region": "us-phoenix-1",
	"serviceLevel": "PAAS",
	"serviceName": "<serviceName>",
	"serviceVersion": "12cRelease214",
	"subnet": "<subnetOCID>",
	"vmPublicKeyText": "<public-key>"
}

Example of Request Body when OTD is provisioned in Oracle Cloud Infrastructure Using a Native RAC Database

The following example shows the request body in JSON format to provision an Oracle SOA Cloud Service instance in Oracle Cloud Infrastructure using an Oracle Cloud Infrastructure (native) RAC database. When provisioning a Oracle SOA Cloud Service instance using a RAC database with more than one node, use the parameter isOciRacDb. 
{
	"availabilityDomain":"bcaH:PHX-AD-1",
	"cloudStorageContainer": "<cloudStorageContainerURL>",
	"cloudStorageUser": "<cloudStorageUser>",
	"cloudStoragePassword": "<cloudStoragePassword>",
	"components": {
		"OTD": {
			"loadBalancingPolicy": "LEAST_CONNECTION_COUNT",
			"shape": "VM.Standard2.1"
		},
		"WLS": {
			"adminUserName": "<adminUserName>",
			"adminPassword": "<adminPassword>",
			"connectString": "//<dbScanHostName>.<dbHostDomainName>:<port>/<PDBname>.<dbHostDomainName>",
			"dbaName": "<dbaName>",
			"dbaPassword": "<dbaPassword>",
			"dbType": "OCINativeDB",
			"isOciRacDb": "true",
			"managedServerCount": "1",
			"shape": "VM.Standard2.1"
		}
	},
	"edition": "SUITE",
	"enableAdminConsole": "true",
	"enableNotification": "false",
	"isBYOL": "false",
	"loadBalancerOption": "OTD",
	"meteringFrequency": "HOURLY",
	"provisionOTD": "true",
	"purchasePack": "soaosbb2b",
	"serviceLevel": "PAAS",
	"serviceName": "<serviceName>",
	"serviceVersion": "12cRelease214",
	"subnet": "<subnetOCID>",
	"region": "us-phoenix-1",
	"vmPublicKeyText": "<public-key>"
}

Example of Request Body in Oracle Cloud Infrastructure Using an Autonomous Transaction Processing (ATP) Database

The following example shows the request body in JSON format to provision an Oracle SOA Cloud Service instance in Oracle Cloud Infrastructure using an Autonomous Transaction Processing (ATP) database. In this example, an OTD load balancer is not provisioned. Note that IP reservations are not applicable when creating service instances in Oracle Cloud Infrastructure.

Note:

cloudStorageContainerAutoGenerate and ipReservations are not available on Oracle Cloud Infrastructure. 

{
	"availabilityDomain":"bcaH:PHX-AD-1",	
	"cloudStorageContainer": "<cloudStorageContainerURL>",
	"cloudStorageUser": "<cloudStorageUser>",
	"cloudStoragePassword": "<cloudStoragePassword>",	
	"components": {
		"WLS": {
			"adminUserName": "<adminUserName>",
			"adminPassword": "<adminPassword>",
			"atpDBName": "<ATPDBName>",
			"dbaName": "<dbaName>",			
			"dbaPassword": "<dbaPassword>",
			"dbType": "ATP",
			"managedServerCount": "1",
			"shape": "VM.Standard2.1"
		}
	},	
	"edition": "SUITE",
	"enableAdapters": "false",
	"enableAdminConsole": "false",
	"enableNotification": "true",	
	"isBYOL": "true",
	"loadBalancerOption": "NONE",
	"meteringFrequency": "HOURLY",	
	"notificationEmail": "<emailID>",
	"purchasePack": "soaosbb2b",
	"region": "us-phoenix-1",	
	"serviceLevel": "PAAS",
	"serviceName": "<serviceName>",	
	"serviceVersion": "12cRelease214",	
	"subnet": "<subnetOCID>",
	"vmPublicKeyText": "<public-key>"
}

Example of Request Body when OTD is provisioned in Oracle Cloud Infrastructure Classic

The following example shows the request body in JSON format to provision an Oracle SOA Cloud Service instance in Oracle Cloud Infrastructure Classic using Oracle Database Classic Cloud Service with an OTD load balancer. It shows a request document that uses a region and IP reservations for the OTD nodes.

The number of names in ipReservations must correspond to the number of Managed Server nodes to provision in the cluster. For OTD, the number of names in ipReservations must correspond to the number of load balancer nodes you want to provision. 

{
	"availabilityDomain":"bcaH:PHX-AD-1",
	"cloudStorageContainer": "<cloudStorageContainerURL>", 
	"cloudStorageContainerAutoGenerate" : "true",
	"cloudStorageUser": "<cloudStorageUser>",
	"cloudStoragePassword": "<cloudStoragePassword>", 
	"components": {
		"OTD": { 
			"adminPort" : "8999",
			"haEnabled": "false", 
			"ipReservations": ["ipres03"],
			"listenerPortsEnabled":"true",
			"listenerPort" : "8090",
			"loadBalancingPolicy": "LEAST_CONNECTION_COUNT/LEAST_RESPONSE_TIME/ROUND_ROBIN",
			"privilegedListenerPort" : "90",
			"privilegedSecuredListenerPort" : "453",
			"securedListenerPort" : "8091",
			"shape": "oc3/oc4/oc5/oc6"
		},
		"WLS": { 
			"adminPort" : "7011",
			"adminUserName": "<adminUserName>",
			"adminPassword": "<adminPassword>", 
			"contentPort" : "8011", 
			"dbServiceName": "<dbServiceName>", 
			"dbaName": "<dbaName>", 
			"dbaPassword": "<dbaPassword>", 
			"deploymentChannelPort" : "9011",
			"ipReservations": ["ipres01", "ipres02"],
			"managedServerCount": "2", 	
			"securedAdminPort" : "7012", 
			"securedContentPort" : "8012",
			"shape": "oc1m/oc2m/oc3m/oc4m"
		} 
	},
	"edition": "SUITE", 
	"enableAdapters":"true",
	"enableAdminConsole" : true, 
	"ipNetwork" : "/Compute-exampleidentitydomain/username@companyname.com/ipnet-1",
	"isBYOL":"true",
	"meteringFrequency": "MONTHLY/HOURLY", MONTHLY for JAVAMB/SBE, HOURLY for UCM accounts
	"provisionOTD": "true",
	"purchasePack": "soaosbb2b",
	"region": "us-phoenix-1",
	"serviceDescription": "<Description for OCI Classic>",
	"serviceLevel": "PAAS", 
	"serviceName": "<serviceName>", 
	"serviceVersion": "12cRelease214",
	"subnet": "<subnetOCID>",
	"vmPublicKeyText": "<publicKey>" 
}

Example of Request Body when OTD is not provisioned in Oracle Cloud Infrastructure Classic

The following example shows the request body in JSON format to provision an Oracle SOA Cloud Service instance in Oracle Cloud Infrastructure Classic using Oracle Database Classic Cloud Service without an OTD load balancer. 

{
	"cloudStorageContainer": "<cloudStorageContainerURL>",
	"cloudStorageUser": "<cloudStorageUser>", 
	"cloudStoragePassword": "<cloudStoragePassword>", 
	"components": {
		"WLS": { 
			"adminUserName": "<adminUserName>",
			"adminPassword": "<adminPassword>", 
			"dbaName": "<dbaName>", 
			"dbaPassword": "<dbaPassword>", 
			"dbServiceName": "<dbServiceName>", 
			"managedServerCount": "1",
			"shape": "oc1m/oc2m/oc3m/oc4m"
		} 
	},
	"edition": "SUITE", 
	"enableAdapters":"true",
	"ipNetwork" : "/Compute-exampleidentitydomain/username@companyname.com/ipnet-1",
	"isBYOL":"true",
	"meteringFrequency": "MONTHLY/HOURLY", MONTHLY for JAVAMB/SBE, HOURLY for UCM accounts, 
	"provisionOTD": "false", 
	"purchasePack": "soaosbb2b",
	"region": "us-phoenix-1",
	"serviceDescription": "<Description for OCI Classic>",
	"serviceLevel": "PAAS", 
	"serviceName": "<serviceName>", 
	"serviceVersion": "12cRelease214",
	"vmPublicKeyText": "<publicKey>" 
}

Example of Response Body

The following example shows the response body in JSON format.

{
  "details": {
    "message": "Submitted job to create service [serviceName] in domain [domainName].",
    "jobId": "28201"
  }
}   
Back to Top