REST API for Oracle Java Cloud Service

Create the Request Document (old path)

Review the request payload structure before you create a request document that defines the details of your Oracle Java Cloud Service instance.

Note: This topic is not relevant to Oracle Cloud Infrastructure or Oracle Cloud Infrastructure Classic. Instead, see Create the Request Document (new path).

You must create the request document before you can provision your first service instance.

Be sure to complete the prerequisite tasks as described in the Prerequisites section in Quick Start before you create the request document.

Sample Request Document

The following provides a sample of a request document in JSON format. Variable information that you will need to customize are shown in bold italics. Copy the sample JSON document contents into a file named create.json, then modify the values.

{
    "serviceName" : "MyFirstInstance",
    "level" : "PAAS",
    "subscriptionType" : "HOURLY",
    "enableAdminConsole" : true,
    "description" : "My first instance using the REST API.",
    "provisionOTD" : true,
    "cloudStorageContainer" : "yourCloudStorageContainer",
    "cloudStorageUser" : "yourCloudStorageUser",
    "cloudStoragePassword" : "yourCloudStoragePassword",
    "createStorageContainerIfMissing" : true,
    "sampleAppDeploymentRequested" : true,
    "parameters" : [
    {
        "type" : "weblogic",
        "version" : "12.1.3",
        "edition" : "SUITE",
        "domainMode" : "PRODUCTION",
        "managedServerCount" : "2",
        "adminPort" : "7001",
        "deploymentChannelPort" : "9001",
        "securedAdminPort" : "7002",
        "contentPort" : "7003",
        "securedContentPort" : "7004",
        "domainName" : "MyDomain",
        "clusterName" : "MyDomain_Cluster",
        "adminUserName" : "yourWLSAdminUserName",
        "adminPassword" : "yourWLSAdminPassword",
        "nodeManagerPort" : "5556",
        "nodeManagerUserName" : "yourNMUserName",
        "nodeManagerPassword" : "yourNMPassword",
        "dbServiceName" : "yourDBCSName",
        "dbaName" : "yourDBUserName",
        "dbaPassword" : "yourDBCSPassword",
        "shape" : "oc3",
        "domainVolumeSize" : "10G",
        "backupVolumeSize" : "50G",
        "VMsPublicKey" : "yourSSHPublicKeyString"
    },
    {
        "type" : "OTD",
        "adminUserName" : "yourOTDUserName",
        "adminPassword" : "yourOTDPassword",
        "listenerPortEnabled" : true,
        "listenerPort" : "8080",
        "listenerType" : "http",
        "securedListenerPort" : "8081",
        "loadBalancingPolicy" : "least_connection_count",
        "adminPort" : "8989",
        "shape" : "oc3",
        "VMsPublicKey" : "yourSSHPublicKeyString"
 
    },
    {
        "type" : "datagrid",
        "scalingUnitCount"  : "1",
        "clusterName"       : "ExampleDGCluster",
        "scalingUnitName"   : "SMALL"
    }  
    ]
}

Note: enableAdminConsole is set to true in the sample request document. This means the access rules that control external communication to administration consoles (such as the WebLogic Server Administration Console) are enabled.

Values to Modify

After copying the sample JSON, modify the attributes as shown.

Attribute	Description
`adminPassword`	Password for WebLogic Server or Oracle Traffic Director administrator. The password must meet these requirements: Starts with a letter Is between 8 and 30 characters long Contains at least one upper case letter, at least one lower case letter, at least one number, and optionally any number of these special characters: Hyphen sign (-) Pound sign (#) Underscore (_) Dollar sign ($) If the service instance is using Exadata as the database, the password cannot contain the dollar sign ($). If a password is not specified for Oracle Traffic Director (`"type":"otd"`), the value defaults to the WebLogic Server administrator password.
`adminUserName`	User name for WebLogic Server or 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 These special characters: Left angle bracket (<) Right angle bracket (>) Ampersand (&) Pound sign (#) Pipe symbol (\|) Question mark (?) If a user name is not specified for Oracle Traffic Director (`"type":"otd"`), the value defaults to the WebLogic Server administrator user name.
`cloudStorageContainer`	Name of the Oracle Cloud Infrastructure Object Storage Classic container to use for storing your service instance backups. Use one of the following formats to specify the container name: `Storage-<identitydomainid>/<containername>` `<storageservicename>-<identitydomainid>/<containername>` `https://foo.storage.oraclecloud.com/v1/MyService-bar/MyContainer` The format to use to specify the Object Storage container name depends on the URL of your Object Storage service account. To identify the URL of your account, see About REST URLs for Oracle Storage Cloud Service Resources in Using Oracle Cloud Infrastructure Object Storage Classic. An Object Storage service account is not required if you are creating a BASIC level Oracle Java Cloud Service instance. If you set `createStorageContainerIfMissing` to `true` and specify a container name that does not yet exist in Object Storage, the provisioning system will create the container before it provisions the Oracle Java Cloud Service instance.
`cloudStoragePassword`	Password of the Object Storage user who has read/write access to the existing or new container.
`cloudStorageUser`	User name of the Object Storage user who has read/write access to the existing or new container.
`dbaName`	User name for the database administrator. For 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 instances based on Oracle WebLogic Server 12c (12.2.1 or 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`	Database administrator password that was specified when the Oracle Database Cloud Service database deployment was created.
`dbServiceName`	Name of your Oracle Database Cloud Service database deployment. This database deployment is required to host the Oracle Required Schema for the Oracle Java Cloud Service instance.
`nodeManagerPassword`	Password for Node Manager. This value defaults to the WebLogic Server administrator password, if not specified. The Node Manager password cannot be changed after the Oracle Java Cloud Service instance is provisioned.
`nodeManagerUserName`	User name for Node Manager. This value defaults to the WebLogic Server administrator user name.
`VMsPublicKey`	The public key for the secure shell (SSH). The key will be used for authentication when connecting to the Oracle Java Cloud Service instance using an SSH client. You generate an SSH public-private key pair using a standard SSH key generation tool. You must specify a public key value for both the service instance and the load balancer.