REST API for Oracle SOA Cloud Service on Oracle Public Cloud Machine

Provision a New Service Instance

post

/api/v1.1/instances/{identityId}

Provisions a new service instance in a domain.

Request

Supported Media Types

application/json

Path Parameters

identityId: Type: string

Required: true

Name of the identity domain for the Oracle Cloud Service account.

Body Parameter

Provision Payload

Root Schema : InstanceProvisionPayload

Type: object

Properties

cloudStorageContainer

Type: string

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.

description

Type: string

Free-form text that provides additional information about the service instance.

level

Type: string

Service level. Valid values include:

PAAS- Production-level service. Supports Oracle SOA Cloud Service instance creation and monitoring; backup and restoration; patching; and scaling. This is the default.

parameters

Type: array parameters

Groups component-specific attributes in the following categories:

WebLogic Server ("type":"weblogic")
Oracle Traffic Director ("type":"otd")

provisionOTD

Type: boolean

Default Value: false

Flag that specifies whether to enable the load balancer. This value defaults to true when you configure more than one Managed Server for the Oracle SOA Cloud Service instance. Otherwise, defaults to false.

publicNetwork

Type: string

Path to the network from which the Oracle SOA Cloud Service REST API is accessed.

serviceName

Type: string

Name of Oracle SOA Cloud Service instance. The service name:

Must not exceed 50 characters.
Must start with a letter.
Must contain only letters, numbers, or hyphens.
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

subscriptionType

Type: string

Billing unit. Valid values include:

MONTHLY - Pay one price for the full month irrespective of the number of hours used.

topology

Type: string

Topology Name. Valid values include:

osb - Oracle Service Bus Topology.
soa - Service Oriented Architecture.
soaosb - Both OSB and SOA Topology.
b2b - Both B2B (Business to Business) and SOA Topology.
mft - MFT (Managed File Transfer) Topology.
insight - Oracle Business Insight (Business Activity Monitoring) Topology.

Nested Schema : parameters

Type: array

Groups component-specific attributes in the following categories:

WebLogic Server ("type":"weblogic")
Oracle Traffic Director ("type":"otd")

Items

Type: object Parameter

Nested Schema : Parameter

Type: object

Properties

adminPassword

Type: string

Note: 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 (_).

adminUserName

Type: string

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

Username for the WebLogic Server administrator. The name must be between 8 and 128 characters long 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 (?).

connectString

Type: string

The string used to connect to the database.

The connection string must be entered using one of the following formats:

host:port/SID
host:port/serviceName

dbaName

Type: string

Note: 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.

dbaPassword

Type: string

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

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

dbNetwork

Type: string

Path to the network through which the Oracle SOA Cloud Service instance accesses the database.

listenerPortsEnabled

Type: boolean

Default Value: false

Note: This attribute is valid when component type is set to otd only; it is not valid for weblogic.

Flag that specifies whether the listener ports are enabled on the load balancer. This flag defaults to true.

loadBalancingPolicy

Type: string

Note: 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.

managedServerCount

Type: string

Note: 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.

otdAdminPassword

Type: string

Note: This attribute is valid when component type is set to otd only.

Password for Oracle Traffic Director 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 (_).

This value defaults to the WebLogic Server administrator password, if not specified.

otdAdminUserName

Type: string

Note: This attribute is valid when component type is set to otd only.

Username for the Oracle Traffic Director administrator. The name must be between 8 and 128 characters long 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 value defaults to the WebLogic Server administrator username, if not specified.

shape

Type: string

Note: 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

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
oc7: 16 OCPUs, 120 GB memory

See About Machine Images and Shapes in Using Oracle Compute Cloud Service for more information about shapes. See About Custom Capacity Units and Advanced Configuration for Oracle SOA Cloud Service-Coherence Instances in Using Oracle SOA Cloud Service for guidelines on defining properties for a custom capacity unit.

type

Type: string

Component type to which the set of parameters applies. Valid values include:

weblogic - Oracle WebLogic Server
otd - Oracle Traffic Director (load balancer)

version

Type: string

Note: This attribute is valid when component type is set to weblogic only; it is not valid for otd.

Oracle WebLogic Server software version. Valid values include: 12.1.3.0.4 and 10.3.6.0.9.

VMsPublicKey

Type: string

Note: 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.

If not specified for the load balancer, this value defaults to the VMsPublicKeyName object provided for the WebLogic Server.

Note: You must specify exactly one of the following attributes: VMsPublicKey or VMsPublicKeyName for both WebLogic Server and the load balancer.

Response

Supported Media Types

application/json
text/plain

Default Response

successful operation

Examples

The following example shows how to create an 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 joe@example.com:Welcome123! -d @create.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain

Note:: This example uses the URL prefix for the United States ( soacs). For information about the URL prefixes for other regions of the world, see Send Requests.

Example of Request Body

The following shows an example of the request body in JSON format.

{
  "serviceName": "MyFirstInstance",
  "level": "PAAS",
  "description": "My first instance using the REST API",
  "provisionOTD": true,
  "cloudStorageContainer" : "yourRemoteStorage",
  "publicNetwork":"yourPublicNetwork",
  "parameters": [
    {
      "version": "12.1.3",
      "edition":"SUITE",
      "managedServerCount":"1",
      "templates":"full",
      "adminUserName": "weblogic",
      "adminPassword": "welcome1",
      "connectString" : "yourDBConnectString",
      "dbaName" : "yourDBUsername",
      "dbaPassword" : "yourDBPassword",
      "dbNetwork" : "yourDBNetwork",
      "shape": "oc1m",
      "VMsPublicKey": "ssh-rsa keystring xperiment",
      "type": "weblogic"
    },
    {
      "listenerPortsEnabled": true,
      "loadBalancingPolicy": "LEAST_CONNECTION_COUNT",
      "otdAdminUserName": "otdadmin",
      "otdAdminPassword": "welcome1",
      "shape": "oc3",
      "type": "OTD"
    }
  ]
}

Example of Response Header

The following shows an example of the response header.

The Location header returns the REST resource that can be used to access the status of the create service instance request. For more information, see Get Service Provisioning Status.

HTTP/1.1 100 Continue

HTTP/1.1 202 Accepted
Date: Fri, 23 Jan 2015 22:18:26 GMT
Location: https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/status/create/job/5261
Content-Length: 0
Content-Type: application/json