1. Oracle Java Cloud Service REST APIREST API for Oracle Java Cloud Service
  2. Quick Start
  3. Create the Request Document

Create the Request Document

Create a request document that defines the details you want for your Oracle Java Cloud Service instance.

Be sure to complete all relevant prerequisite tasks as described in Quick Start before you create your request document.

Sample Request Document for Oracle Cloud Infrastructure

The following example is a sample request document for provisioning an Oracle Java Cloud Service instance on Oracle Cloud Infrastructure. It assumes the service instance will be associated with an infrastructure schema database deployment on Oracle Cloud Infrastructure Database (DB System, Virtual Machine).

Note that an Oracle Cloud Infrastructure region and availability domain must be specified. Specify a region that is within the default data region of your account on Oracle Cloud Infrastructure. For example, if the default data region is North America, specify the region such as us-phoenix-1, us-ashburn-1 or ca-toronto-1. If the default data region is EMEA, specify the region as eu-frankfurt-1 or uk-london-1. For other regions, see Data Regions for Platform and Infrastructure Services.

A custom public subnet is also specified in subnet.

The components object defines properties for the WebLogic Server (WLS) component.

  • Only VM.Standard and BM.Standard shapes are supported. See Compute Shapes in the Oracle Cloud Infrastructure documentation.

  • For an Oracle Cloud Infrastructure VM Database system, note that -scan is appended to the hostname prefix in connectString.

The service instance uses the Oracle-managed load balancer by setting configureLoadBalancer to true. Also note that if you are provisioning your service instance in a region that has a single availability domain, then only one load balancer subnet can be provided in subnets.

See Create a Service Instance for complete parameter descriptions. 

{
   "region":"yourRegion",
   "availabilityDomain":"yourAvailabilityDomain",
   "subnet":"yourCustomSubnet",
   "edition":"EE",
   "vmPublicKeyText":"yourSSHPublicKeyString",
   "enableNotification":"true",
   "notificationEmail":"yourEmail",
   "backupDestination":"NONE",
   "serviceVersion":"12cRelease214",
   "serviceLevel":"PAAS",
   "serviceName":"MyFirstInstanceOnOCI",
   "isBYOL":"false",
   "components":{
      "WLS":{
         "domainPartitionCount":"0",
         "adminUserName":"yourWLSAdminUserName",
         "adminPassword":"yourWLSAdminPassword",
         "isOciRacDb":"false",
         "connectString":"//yourhostname-scan.yournetworkdomain:1521/yourpdbname.yournetworkdomain",
         "pdbServiceName":"yourpdbname",
         "dbaName":"SYS",
         "dbaPassword":"yourdbapassword",
         "clusters":[
            {
               "serverCount":"1",
               "shape":"VM.Standard2.1",
               "type":"APPLICATION_CLUSTER"
            }
         ],
         "sampleAppDeploymentRequested":"true"
      }
   },
   "configureLoadBalancer": "true",
   "loadbalancer":{
      "subnets":[
         "yourNode1subnet",
         "yourNode2subnet"
      ],
      "loadBalancingPolicy":"ROUND_ROBIN"
   },
   "enableAdminConsole":"true",
   "meteringFrequency":"HOURLY"
}

Sample Request Document for Oracle Cloud Infrastructure Classic

The following example is a sample request document for provisioning an Oracle Java Cloud Service instance without specifying a region on Oracle Cloud Infrastructure Classic. It assumes the service instance will be associated with an infrastructure schema database deployment on Oracle Database Cloud Service (Classic).

The components object defines properties for the WebLogic Server (WLS) component, and properties for the Oracle Traffic Director (OTD) component as an optional user-managed load balancer.

If you wish to use the Oracle-managed load balancer instead of Oracle Traffic Director, set provisionOTD to false, leave out the OTD component, and set useIdentityService to true.

See Create a Service Instance for complete parameter descriptions. 

{
    "cloudStorageContainer" : "yourObjectStorageContainer",
    "cloudStorageUser" : "yourObjectStorageUser",
    "cloudStoragePassword" : "yourObjectStoragePassword",
    "serviceDescription" : "My service instance description",
    "serviceLevel" : "PAAS",
    "serviceName" : "MyFirstInstance",
    "edition" : "EE",
    "serviceVersion" : "12cR4",
    "meteringFrequency" : "HOURLY",
    "provisionOTD" : true,
    "enableAdminConsole" : true,
    "vmPublicKeyText" : "yourSSHPublicKeyString",
    "components" : {
        "WLS" : {
            "adminUserName" : "yourWLSAdminUserName",
            "adminPassword" : "yourWLSAdminPassword",
            "sampleAppDeploymentRequested" : true,
            "domainMode" : "PRODUCTION",
            "dbServiceName" : "yourInfraSchemaDbDeployment",
            "dbaName" : "yourDBUserName",
            "dbaPassword" : "yourInfraSchemaDbDeploymentPassword",
            "clusterName" : "yourClusterName",
            "managedServerCount" : 2,
            "shape" : "oc3",
            "appDBs": [
            {
                "dbaPassword": "yourAppSchemaDBUserPassword",
                "dbServiceName": "yourAppSchemaDbDeployment",
                "dbaName": "yourAppDBUserName"
            }]
        },
        "OTD": {
            "adminUserName" : "yourOTDUserName",
            "adminPassword" : "yourOTDPassword",
            "listenerPortEnabled" : true,
            "listenerPort" : "8080",
            "securedListenerPort" : "8081",
            "loadBalancingPolicy" : "LEAST_CONNECTION_COUNT",
            "haEnabled" : false,
            "adminPort" : "8989",
            "shape" : "oc3"
        }
    }
}

The following shows a request document that uses the clusters array to define one application tier cluster. 

{
    "cloudStorageContainer" : "yourObjectStorageContainer",
    "cloudStorageUser" : "yourObjectStorageUser",
    "cloudStoragePassword" : "yourObjectStoragePassword",
    "serviceDescription" : "My service instance description",
    "serviceLevel" : "PAAS",
    "serviceName" : "MyFirstInstance",
    "edition" : "EE",
    "serviceVersion" : "12cR4",
    "meteringFrequency" : "HOURLY",
    "provisionOTD" : true,
    "enableAdminConsole" : true,
    "vmPublicKeyText" : "yourSSHPublicKeyString",
    "components" : {
        "WLS" : {
            "shape" : "oc3",
            "managedServerCount": 0,
            "clusters" : [
                {
                    "clusterName" : "yourClusterName",
                    "type": "APPLICATION_CLUSTER",
                    "serverCount" : 2
                }           
            ],
            "adminUserName" : "yourWLSAdminUserName",
            "adminPassword" : "yourWLSAdminPassword",
            "sampleAppDeploymentRequested" : true,
            "domainMode" : "PRODUCTION",
            "dbServiceName" : "yourInfraSchemaDbDeployment",
            "dbaName" : "yourDBUserName",
            "dbaPassword" : "yourInfraSchemaDbDeploymentPassword"
        },
        "OTD": {
            "adminUserName" : "yourOTDUserName",
            "adminPassword" : "yourOTDPassword",
            "listenerPortEnabled" : true,
            "listenerPort" : "8080",
            "securedListenerPort" : "8081",
            "loadBalancingPolicy" : "LEAST_CONNECTION_COUNT",
            "haEnabled": "false",
            "adminPort" : "8989",
            "shape" : "oc3"
        }
    }
}