1. REST API for Oracle Java Cloud Service
  2. Tasks
  3. Service Instances

Create a Service Instance

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances

Creates an Oracle Java Cloud Service instance.

Note: You cannot create new Oracle Java Cloud Service instances after March 31st 2023. So, Oracle recommends that you migrate your instances to currently supported version in Oracle WebLogic Server for OCI. For more information, see the My Oracle Support document titled WLS Version Support in JCS, and JCS Controlled Availability (MOS Note 2688042.1).

Optionally, you can:

  • Add a caching (data grid) cluster for Coherence storage.
  • Enable Oracle Traffic Director (OTD) as the user-managed load balancer.
  • Enable Oracle Identity Cloud Service for user authentication and use the Oracle-managed load balancer. This is supported only in accounts that are integrated with Oracle Identity Cloud Service.
  • (Oracle Cloud Infrastructure only) Enable the Oracle-managed load balancer without using Oracle Identity Cloud Service.

Multiple identity domains: If your Oracle Cloud account supports multiple identity domains with Oracle Identity Cloud Service, by default service instances are created in your primary identity domain unless you use identityStripe to specify a secondary identity domain.

Databases: Every Oracle Java Cloud Service instance must be associated with an existing relational database in Oracle Cloud. This database is used to contain the required infrastructure schema for Oracle WebLogic Server. Depending on whether you provision the Oracle Java Cloud Service instance on Oracle Cloud Infrastructure or Oracle Cloud Infrastructure Classic, the infrastructure schema database could be deployed on Oracle Autonomous Transaction Processing, Oracle Cloud Infrastructure Database, Oracle Database Cloud Service (Classic) or Oracle Database Exadata Cloud Service. The database you intend to use must be in an active state and not currently in the process of being provisioned when you create your Oracle Java Cloud Service instance. See the following in Administering Oracle Java Cloud Service:

Service instance clones: You can create a clone of an existing Oracle Java Cloud Service instance, but you must first create a snapshot of the service instance you want to clone. See Snapshots REST Endpoints. You also need to create clones of the infrastructure schema database and any application schema databases associated with the source Java Cloud Service instance you intend to clone. See About Snapshots and Clones in Administering Oracle Java Cloud Service.

The cloning feature is not supported for the following:

  • Service instances that use an Oracle Autonomous Transaction Processing database or Oracle Cloud Infrastructure Database for the infrastructure schema.
  • Service instances that were provisioned with Oracle Identity Cloud Service enabled.

Heap sizes: The heap sizes for the Managed Server processes are determined automatically by the compute shape you specify for the WebLogic component type. See About Heap Size Settings for Oracle Java Cloud Service Instances in Administering Oracle Java Cloud Service. When creating a service instance, you can define your own JVM memory configuration if you don't want to use the computed values, and you can customize the Managed Server JVM arguments configuration.

Exadata database and IP reservations: (Not supported on Oracle Cloud Infrastructure) If you plan to use an Oracle Exadata database with an Oracle Java Cloud Service instance in an account where regions are not supported, see the My Oracle Support document titled How to Request Authorized IPs for Provisioning a Java Cloud Service with Database Exadata Cloud Service (MOS Note 2163568.1) to submit a request for IP reservations. You must obtain IP reservations for the Managed Servers you are going to provision before creating the service instance. The number of IP reservations you need corresponds to the number of Managed Server nodes you want to provision in the cluster.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
The request body defines the details of the create request.
Root Schema : create-postrequestm
Type: object
Show Source
  • Flag that specifies the Classless Inter-Domain Routing (CIDR) range to access the WebLogic Server Administration Console. The default value is 0.0.0.0/0. To specify a value, enableAdminConsole must be set to true.
  • This attribute is only applicable if a value is specified in identityStripe.

    The administrator of the specified identity domain or a valid user in the specified identity domain.

  • This attribute is applicable only when provisioning an Oracle Java Cloud Service instance in a region on Oracle Cloud Infrastructure Classic, and a custom IP network is specified in ipNetwork.

    Flag that specifies whether to assign (true) or not assign (false) public IP addresses to the nodes in your service instance. The default is true, which means any node added during service instance provisioning, or later added as part of a scaling operation, will have a public IP address assigned to it. You will be able to directly access the nodes from the public Internet.

    When set to false, this means any node added during instance provisioning, or later added as part of a scaling operation, will not have a public IP address assigned to it. You will not be able to directly access the nodes from the public Internet.

  • This required attribute is applicable only when creating Oracle Java Cloud Service instances on Oracle Cloud Infrastructure.

    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.

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

  • This attribute is applicable only when serviceLevel is set to PAAS. Specifies whether to enable backups for this Oracle Java Cloud Service instance.

    Valid values include:

    • BOTH - Enable backups. This is the default. This means automated scheduled backups of the service instance are enabled, and on-demand backups can be initiated. All backups are stored on disk (in a volume attached to the nodes) and in the object storage container or bucket that is specified in cloudStorageContainer. See also disabledScheduledCoordinatedBackups.
    • NONE - Do not enable backups. This means automated scheduled backups of the service instance are not enabled, and on-demand backups cannot be initiated. When set to NONE, cloudStorageContainer is not required.

  • URI of the object storage bucket or container for storing Oracle Java Cloud Service instance backups.

    Do not use a bucket or container that you use to back up Oracle Java Cloud Service instances for any other purpose. For example, do not also use the same bucket or container to back up the associated infrastucture schema database. Using one bucket or container for multiple purposes can result in billing errors.

    This attribute is not required if:

    • backupDestination is set to NONE
    • serviceLevel is set to BASIC

    On Oracle Cloud Infrastructure, the object storage bucket must be created before provisioning your Oracle Java Cloud Service instance. Do not use the same bucket for more than one instance. For the instructions to create a bucket, see Prerequisites for Oracle Platform Services on Oracle Cloud Infrastructure in the Oracle Cloud Infrastructure documentation. Enter the bucket URL in the following format:

    https://swiftobjectstorage.<region>.oraclecloud.com/v1/<namespace>/<bucket>.

    To find out your namespace, sign in to the Oracle Cloud Infrastructure web console, click the tenancy name, and look for the Object Storage Namespace field.

    Example:

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

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

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

    • Storage-<identitydomainid>/<containerName>
    • <storageservicename>-<identitydomainid>/<containerName>
    • <restEndPointURL>/<containerName>

    To identify the REST endpoint URL of your object storage service, see Finding the REST Endpoint URL for Your Cloud Account in Using Oracle Cloud Infrastructure Object Storage Classic.

    If your Oracle Cloud account is created with OAuth protected object storage and you do not want to use the default OAuth protected object storage for instance backups, see useOAuthForStorage.

  • This attribute is not applicable when provisioning an Oracle Java Cloud Service instance on 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 object storage user. The password must be specified if cloudStorageContainer is set, but note the following:

    On Oracle Cloud Infrastructure, this is the Auth token generated on Oracle Cloud Infrastructure for the user specified in cloudStorageUser.

    On Oracle Cloud Infrastructure Classic and Oracle Cloud at Customer, this is the password for the Oracle Cloud Infrastructure Object Storage Classic user who has read and write access to the container that is specified in cloudStorageContainer. This attribute is not required for the BASIC service level.

    If a service instance on Oracle Cloud Infrastructure Classic is using Oracle Identity Cloud Service, this attribute is not required if the current cloud user is entitled to use Oracle Cloud Infrastructure Object Storage Classic.

  • User name for the object storage user. The user name must be specified if cloudStorageContainer is set, but note the following:

    On Oracle Cloud Infrastructure, this is the user name for the Oracle Cloud Infrastructure Object Storage user.

    On Oracle Cloud Infrastructure Classic and Oracle Cloud at Customer, this is the user name for the Oracle Cloud Infrastructure Object Storage Classic user who has read and write access to the container that is specified in cloudStorageContainer. This attribute is not required for the BASIC service level.

    If a service instance on Oracle Cloud Infrastructure Classic is using Oracle Identity Cloud Service, this attribute is not required if the current cloud user is entitled to use Oracle Cloud Infrastructure Object Storage Classic.

  • components
    Groups properties for the Oracle WebLogic Server component (WLS) and the optional Oracle Traffice Director (OTD) component.
  • This attribute is applicable only when creating an Oracle Java Cloud Service instance on Oracle Cloud Infrastructure.

    Flag that specifies whether to enable the Oracle-managed load balancer for this service instance. Default value is false. Note the following:

    • If you need the ability to update the Oracle Cloud Infrastructure Load Balancing configuration for an Oracle Java Cloud Service instance, do not set the value to true because you cannot update the Oracle Cloud Infrastructure Load Balancing configuration if the load balancer is provisioned automatically during the creation of the service instance. To be able to update the configuration of the Oracle-managed load balancer instance provisioned for your service instance, you must create and configure the load balancer manually (after you have created your service instance). See Set Up an Oracle Cloud Infrastructure Load Balancer in Administering Oracle Java Cloud Service.
    • The value must be set to true if useIdentityService is set to true (to enable Oracle Identity Cloud Service for authenticating Oracle WebLogic Server administrators and application users).
    • The value can be true without setting useIdentityService to true.

    Provisioning a load balancer is recommended if you are configuring more than one Managed Server. Only configureLoadBalancer or provisionOTD (Oracle Traffic Director as the user-managed load balancer) can be true (in other words, if one is true, the other must be false).

    When configureLoadBalancer is set to true, the Oracle-managed, dual-node load balancer (that can be accessed using a single IP address) is provisioned and configured for the Oracle Java Cloud Service instance. The Oracle-managed load balancer, which is maintained and patched by Oracle, runs on Oracle Cloud Infrastructure Load Balancing. See loadbalancer for the load balancer options you can set (during creation of the Oracle Java Cloud Service instance). The Oracle-managed load balancer that is provisioned automatically cannot be removed after the service instance is created.

    Note also the following when considering whether to use the Oracle-managed load balancer or Oracle Traffic Director (OTD) as a user-managed load balancer: All the nodes in a service instance (WebLogic Server WLS and OTD nodes) are attached to the subnet that you can specify for the instance. If you want the WLS nodes in a private subnet and the load balancer in a public subnet, then use subnet to attach the instance to a private subnet, enable the use of the Oracle-managed load balancer, and specify public subnets for the loadbalancer nodes.

  • Flag that specifies whether a scheduled Oracle Java Cloud Service instance backup will include a backup of the associated database deployment.

    A value of false means a backup of the associated database deployment is coordinated and enabled. A value of true means a coordinated database deployment backup is not performed (disabled) during a scheduled backup of this service instance.

    Default is true.

    If the Oracle Java Cloud Service instance has backupDestination set to NONE, the attribute is ignored.

    Note: This attribute is not applicable to an Oracle Java Cloud Service instance that uses Oracle Database Exadata Cloud Service for the required infrastructure schema; the attribute is ignored if it is specified. This attribute is also not applicable to service instances that use an Oracle Autonomous Transaction Processing database or Oracle Cloud Infrastructure Database (DB system) to host the infrastructure schema. Coordinated backups are not available for such service instances.

  • Software edition for Oracle WebLogic Server. Valid values include:
    • SE - Standard edition. See Oracle WebLogic Server Standard Edition. Do not use the Standard edition if you are enabling domain partitions using WebLogic Server 12.2.1, or using upperStackProductName to provision a service instance for an Oracle Fusion Middleware product. Scaling a cluster is also not supported on service instances that are based on the Standard edition.
    • EE - Enterprise Edition. This is the default for both PAAS and BASIC service levels. See Oracle WebLogic Server Enterprise Edition.
    • SUITE - Suite edition (Enterprise Edition with Coherence). See Oracle WebLogic Suite.

    Set the edition value to SUITE if either is applicable:

    • You are creating an instance with a caching (data grid) cluster
    • You want a high performance edition

    On Oracle Cloud Infrastructure: Additional restrictions may apply. For example, SUITE is required if you are using an Oracle Cloud Infrastructure RAC database for the associated infrastructure schema. See the following:

  • 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.

    On Oracle Cloud Infrastructure: The default value is true. 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.

    On Oracle Cloud Infrastructure Classic: 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 Disable, Enable or Delete an Access Rule.

  • Flag that specifies 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 optional attribute is applicable only to Cloud accounts where multiple identity domains are supported in Oracle Identity Cloud Service.

    Name of a secondary identity domain where the Oracle Java Cloud Service instance will be provisioned.

    If not specified, the service instance is provisioned in the primary identity domain (default). The primary identity domain is the initial domain that was created when the Cloud account was set up.

    Note the following when specifying a secondary identity domain:

    • Your associated infrastructure schema database must be deployed on Oracle Autonomous Transaction Processing or Oracle Cloud Infrastructure Database (DB System).
    • useIdentityService must be set to true (that is, Oracle Identity Cloud Service must be enabled).
    • configureLoadBalancer must also be set to true.

  • This attribute is not applicable when provisioning Oracle Java Cloud Service instances on Oracle Cloud Infrastructure.

    This attribute is applicable only to accounts where regions are supported.

    The three-part name of a custom IP network to attach this service instance to. For example:

    /Compute-identity_domain/user/object

    A region name must be specified in order to use ipNetwork. Only those IP networks already created in the specified Oracle Cloud Infrastructure Compute Classic region can be used.

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

    If you are provisioning a Java Cloud Service instance with useIdentityService set to true, the ipNetwork you want to use must meet one of the following conditions:

    • A public-facing (Internet-facing) or private load balancer must already be attached to the ipNetwork you specify.
    • The ipNetwork you specify is connected to an IP Network Exchange that has another IP network to which a public-facing or private load balancer is already attached.

    During provisioning, if a load balancer is not found, an error message is returned and the instance creation operation will stop. You must first attach a public or private load balancer to the ipNetwork you want to use before you try to create the Java Cloud Service instance again. See Creating a Load Balancer in Using Oracle Cloud Infrastructure Load Balancing Classic.

    If you specify an IP network, the dbServiceName for this service instance must also be attached to an ipNetwork. If this service instance and the associated database deployment are attached to different IP networks, the two IP networks must be connected to the same IP network exchange.

    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 in ipReservations. Note that to use ipReservations, assignPublicIP must be true.

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

  • Flag that specifies whether to apply an existing on-premises license for Oracle WebLogic Server (true) to the new Oracle Java Cloud Service instance you are provisioning. A Universal Credits subscription or a Government 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 Oracle Cloud account only has BYOL entitlements, the default value is true. You cannot change it to false.
    • If the Oracle 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.

    Note that you are responsible for ensuring that you have the required licenses for all BYOL instances in Oracle Java Cloud Service. For example, before you scale up or scale out a BYOL instance, you must have enough WebLogic Server licenses for the additional OCPUs that will be allocated to the instance after it is scaled.

    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.

  • loadbalancer
    Groups properties for the Oracle-managed load balancer, which is maintained and patched by Oracle.

    The Oracle-managed load balancer is an instance of Oracle Cloud Infrastructure Load Balancing (on Oracle Cloud Infrastructure) or Oracle Cloud Infrastructure Load Balancing Classic (on Oracle Cloud Infrastructure Classic).

    This attribute is applicable when provisioning a service instance with useIdentityService set to true. See loadBalancingPolicy for the load balancer policy options you can set.

    In addition, on Oracle Cloud Infrastructure:

    • This attribute is also applicable when provisioning a service instance without enabling Oracle Identity Cloud Service, but with configureLoadBalancer set to true.
    • Regardless of whether useIdentityService is set to true, if a specific subnet is specified for the service instance, you must also specify subnets for the Oracle-managed load balancer nodes (node 1 and node 2). See subnets.
    • If you need the ability to update the Oracle-managed load balancer configuration for an Oracle Java Cloud Service instance, do not provision the load balancer during the creation of the service instance. This is because you cannot update the Oracle-managed load balancer configuration if the load balancer is provisioned automatically during the creation of the service instance. To be able to update the configuration of the Oracle-managed load balancer instance provisioned for your service instance, you must create and configure the load balancer manually (after you have created your service instance). See Set Up an Oracle Cloud Infrastructure Load Balancer in Administering Oracle Java Cloud Service.

  • This attribute is applicable only when creating an Oracle Java Cloud Service instance with an Oracle-managed load balancer.

    Type of Oracle-managed load balancer. Valid values are:

    • PUBLIC - The Oracle-managed load balancer is accessible over the Internet. This is the default.
    • PRIVATE - The Oracle-managed load balancer is not accessible over the Internet. Note that this type is not available on Oracle Cloud Infrastructure.

    On Oracle Cloud Infrastructure Classic, this attribute is applicable only when provisioning a service instance on a specific IP network (ipNetwork) and Oracle Identity Cloud Service is enabled (where useIdentityService is set to true).

  • Metering frequency. This attribute is only applicable if you have a traditional metered subscription; it is not applicable if you have a Universal Credits subscription.

    Valid values include:

    • HOURLY - Pay only for the number of hours used during your billing period. This is the default.
    • MONTHLY - 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.

  • This attribute is applicable only when provisioning an Oracle Java Cloud Service instance that uses Oracle Identity Cloud Service (where useIdentityService is set to true), to enable Oracle Identity Cloud Service for authenticating Oracle WebLogic Server administrators and application users.

    Supply this attribute when you want to include additional URL patterns to use to protect JavaEE applications.

    A comma separated list of context roots that you want protected by Oracle Identity Cloud Service.

    Each context root must begin with the / character. For example:

    /store/departments/.*,/store/cart/.*,/marketplace/.*,/application1/.*

  • Flag that specifies whether to enable Oracle Traffic Director (OTD) as a user-managed load balancer for the Oracle Java Cloud Service instance. Default value is false.

    Provisioning a load balancer is recommended if you are configuring more than one Managed Server for the service instance. When set to true, all the WebLogic Server WLS nodes and OTD nodes in the service instance are assigned to the same IP network or subnet.

    This attribute cannot be true if useIdentityService is set to true. This is because when useIdentityService is true, the Oracle-managed load balancer is configured.

    In addition, on Oracle Cloud Infrastructure, this attribute cannot be true if configureLoadBalancer is true (without enabling Oracle Identity Cloud Service).

  • This attribute is applicable only to accounts where regions are supported.

    Name of the region where the Oracle Java Cloud Service instance is to be provisioned.

    On Oracle Cloud Infrastructure: An Oracle Cloud Infrastructure region must be specified to provision your service instance on Oracle Cloud Infrastructure resources. Be sure to specify a region that is within the default data region of your account on Oracle Cloud Infrastructure. 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.

    You must use the same region as the one where your Oracle Autonomous Transaction Processing database, Oracle Cloud Infrastructure Database (DB system), or Oracle Database Cloud Service (Classic) database deployment resides.

    Note also the following when provisioning on Oracle Cloud Infrastructure:

    • An availability domain must also be specified using availabilityDomain. See the description for availabilityDomain.
    • A subnet can be specified using subnet. See the description for subnet.
    • Database instances in Oracle Cloud Infrastructure Database and Oracle Database Cloud Service must be in the same region and virtual cloud network (VCN) as the Oracle Java Cloud Service instance. The database and service instance do not need to be in the same subnet or availability domain, but you may have to create the necessary security rules in the VCN to enable communication between the subnets. The database and service instance can be on different VCNs only if you configure VCN peering.

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

    On Oracle Cloud Infrastructure Classic: A region name is optional. It must be specified if you intend to use ipReservations or ipNetwork. For Classic regions, see Data Regions for Platform and Infrastructure Services.

    If you do not specify a region, the service instance is created in the same site as the associated infrastructure schema database deployment. However, you will not be able to use an IP network or reserved IP addresses for the service instance.

    If a region name is specified, the database deployment that you intend to associate with your service instance must be in the same region.

    If creating a clone using a snapshot, the region of the clone must be the same as the source Oracle Java Cloud Service instance.

  • Free-form text that provides additional information about the service instance.
  • Service level. Valid values include:
    • PAAS - Production-level service. This is the default. Supports Oracle Java Cloud Service instance creation and monitoring, backup and restoration, patching, and scaling. To enable domain partitions using WebLogic Server 12.2.1, you must specify the PAAS service level.
    • BASIC - Development-level service. Supports Oracle Java Cloud Service instance creation and monitoring but does not support backup and restoration, patching, or scaling.

    Note: The BASIC service level is:

    • Not supported for Oracle Cloud Infrastructure regions
    • Not supported if you have a Universal Credits subscription

  • Name of Oracle Java Cloud Service instance. The service name:
    • Must not exceed 30 characters.
    • Must start with a letter.
    • Must contain only letters and numbers.
    • Must not contain any special characters (including hyphens).
    • 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 WebLogic Server software version.
    • 12cRelease214 - For Oracle WebLogic Server 12c, 12.2.1.4.

      This is the default value for provisioning Oracle Java Cloud Service instances.

      The JDK version for WebLogic Server 12.2.1 is JDK 8.

      On Oracle Cloud Infrastructure: Additional restrictions may apply. For example, 12cRelease214 is valid if you are using an Oracle Autonomous Transaction Processing database for the associated infrastructure schema database. See the following:

  • This attribute and sourceServiceName are required when you provision a clone of an existing Oracle Java Cloud Service instance (the source service instance).

    Name of the snapshot to clone from. See Snapshots REST Endpoints.

    Note: You cannot create a clone of a service instance that is enabled with Oracle Identity Cloud Service, or that uses an Oracle Autonomous Transaction Processing database or Oracle Cloud Infrastructure Database for the infrastructure schema.

  • This attribute and snapshotName are required when you provision a clone of an existing Oracle Java Cloud Service instance.

    Name of the existing Oracle Java Cloud Service instance that has the snapshot from which you are creating a clone.

    The cloning feature is not supported for the following:

    • Service instances that use an Oracle Autonomous Transaction Processing database or Oracle Cloud Infrastructure Database for the infrastructure schema.
    • Service instances that were provisioned with Oracle Identity Cloud Service enabled.

    Note the following when creating a service instance clone:

    • Use snapshotName to specify the name of the snapshot to clone from. See Snapshots REST Endpoints.
    • The clone is created in the same region as the source instance; you cannot change the region value for the clone.
    • The following service level attributes of the source service instance also cannot be changed in the clone: edition, provisionOTD, serviceLevel, and serviceVersion. Of those attributes, the clone operation will always use the same values as found in the snapshot of the source service instance.
    • Specify a clone of the associated infrastructure schema database; do not use the original database as the associated database to host the required infrastructure schema for your Oracle Java Cloud Service instance clone. Similarly, for database deployments that host application schemas (if any), use one or more database deployment clones in the array appDBs.
    • If a caching (data grid) cluster is provisioned in the source service instance, the clone will include a caching cluster that has the exact same configuration for clusterName, shape, serverCount, and serversPerNode. Those attributes cannot be changed in the clone.
    • The following WLS component level attributes of the source service instance cannot be changed in the clone: adminPort, clusterName of application cluster, contentPort, deploymentChannelPort, domainName, domainPartitionCount, managedServerCount, nodeManagerPort, sampleAppDeploymentRequested, securedAdminPort, securedContentPort

  • This attribute is applicable only when creating Oracle Java Cloud Service instances on Oracle Cloud Infrastructure.

    The Oracle Cloud Identifier (OCID) of a subnet from a virtual cloud network (VCN) created on Oracle Cloud Infrastructure.

    See Prerequisites for Oracle Platform Services on Oracle Cloud Infrastructure and VCNs and Subnets in the Oracle Cloud Infrastructure documentation.

    See also Known Issues for Oracle Java Cloud Service.

    You can specify a subnet that you have created yourself, or you can let Oracle Java Cloud Service automatically assign a subnet for you.

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

    To let Oracle Java Cloud Service assign a subnet for you: Do not include subnet in your provisioning request payload. When excluded, Oracle Java Cloud Service automatically assigns a subnet from the VCN named svc-vcn in the ManagedCompartmentForPaaS compartment.

    Note:

    • You must specify a subnet if you intend to specify subnets for the Oracle-managed load balancer nodes.
    • You must specify a subnet if the associated infrastructure schema database is deployed on an Oracle Cloud Infrastructure Database system.
    • Database instances in Oracle Database Cloud Service and Oracle Cloud Infrastructure Database must be in the same region and virtual cloud network (VCN) as the Oracle Java Cloud Service instance. The database and service instance do not need to be in the same subnet or availability domain, but you may have to create the necessary security rules in the VCN to enable communication between the subnets.
    • To use a private subnet, note that several networking, storage, identity, and compute resources must be created in Oracle Cloud Infrastructure. See Create an Oracle Java Cloud Service Instance Attached to a Private Subnet on Oracle Cloud Infrastructure in Administering Oracle Java Cloud Service.

  • tags
    Groups tags for assigning to the service instance after the instance is created. If a tag does not yet assist, it will be created and then assigned to the service instance.
  • This attribute is applicable only to accounts that include Oracle Identity Cloud Service.

    Flag that specifies whether to use Oracle Identity Cloud Service (true) or the local WebLogic identity store (false) for user authentication and to maintain administrators, application users, groups and roles. The default value is false.

    See Use Oracle Identity Cloud Service with Oracle Java Cloud Service in Administering Oracle Java Cloud Service.

    Note: Oracle Identity Cloud Service must be enabled (that is, set to true) if you specify a secondary identity domain in identityStripe.

    Consider the following restrictions when enabling Oracle Identity Cloud Service:

    • serviceLevel must be PAAS
    • provisionOTD must be false
    • serviceVersion must use one of the 12c versions)
    • On Oracle Cloud Infrastructure, configureLoadBalancer cannot be false.

    If you enable Oracle Identity Cloud Service, you do not have the option to configure and manage Oracle Traffic Director (OTD) as a user-managed load balancer that runs within your service instance. Instead, an instance of Oracle Cloud Infrastructure Load Balancing (on Oracle Cloud Infrastructure) or Oracle Cloud Infrastructure Load Balancing Classic (on Oracle Cloud Infrastructure Classic) is created and configured. This Oracle-managed load balancer instance is maintained and patched for you by Oracle. See loadbalancer for the load balancer options you can set (during creation of the Oracle Java Cloud Service instance).

    Note for Oracle Cloud Infrastructure: You cannot update the Oracle-managed load balancer configuration if the load balancer is provisioned automatically during the creation of the Oracle Java Cloud Service instance. If you need the ability to update the Oracle-managed load balancer configuration for a service instance, you must create and configure the load balancer manually (after you have created your service instance without enabling Oracle Identity Cloud Service). See Set Up an Oracle Cloud Infrastructure Load Balancer in Administering Oracle Java Cloud Service.

  • This attribute is applicable only when provisioning an Oracle Java Cloud Service instance on Oracle Cloud Infrastructure Classic.

    This attribute is only applicable to Oracle Cloud accounts that are created with OAuth protected object storage. If you do not want to use the default OAuth protected object storage for instance backups, you must set the attribute to false and specify the following in the payload: cloudStorageContainer, cloudStorageUser, and cloudStoragePassword. cloudStorageContainerAutoGenerate is optional.

  • The public key for the secure shell (SSH). This 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. See Accessing a Node with a Secure Shell (SSH) in Administering Oracle Java Cloud Service.
Nested Schema : components
Type: object
Groups properties for the Oracle WebLogic Server component (WLS) and the optional Oracle Traffice Director (OTD) component.
Show Source
Nested Schema : loadbalancer
Type: object
Groups properties for the Oracle-managed load balancer, which is maintained and patched by Oracle.

The Oracle-managed load balancer is an instance of Oracle Cloud Infrastructure Load Balancing (on Oracle Cloud Infrastructure) or Oracle Cloud Infrastructure Load Balancing Classic (on Oracle Cloud Infrastructure Classic).

This attribute is applicable when provisioning a service instance with useIdentityService set to true. See loadBalancingPolicy for the load balancer policy options you can set.

In addition, on Oracle Cloud Infrastructure:

  • This attribute is also applicable when provisioning a service instance without enabling Oracle Identity Cloud Service, but with configureLoadBalancer set to true.
  • Regardless of whether useIdentityService is set to true, if a specific subnet is specified for the service instance, you must also specify subnets for the Oracle-managed load balancer nodes (node 1 and node 2). See subnets.
  • If you need the ability to update the Oracle-managed load balancer configuration for an Oracle Java Cloud Service instance, do not provision the load balancer during the creation of the service instance. This is because you cannot update the Oracle-managed load balancer configuration if the load balancer is provisioned automatically during the creation of the service instance. To be able to update the configuration of the Oracle-managed load balancer instance provisioned for your service instance, you must create and configure the load balancer manually (after you have created your service instance). See Set Up an Oracle Cloud Infrastructure Load Balancer in Administering Oracle Java Cloud Service.

Show Source
  • Policy to use for routing requests to the origin servers of the Oracle-managed load balancer.

    Valid policy values include:

    • LEAST_CONN - Passes each new request to the server with the least number of active connections.
    • IP_HASH - Uses the incoming request source IP address as a hashing key to determine the server to route each request. Unlike ROUND_ROBIN and LEAST_CONN load balancing where each subsequent client request can be routed to a different server, IP_HASH ensures that requests from the same client are always routed to the same server (as long as the server is available).
    • ROUND_ROBIN - Passes each new request to the next server in line, evenly distributing requests across all servers. This is the default value.

  • subnets
    This attribute is available only on Oracle Cloud Infrastructure.

    This attribute is required if you are provisioning an Oracle Java Cloud Service instance on a specific subnet using subnet.

    Subnets for the Oracle-managed load balancer nodes (node 1 and node 2).

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

    Oracle recommends that you use a regional subnet for the load balancer to support failover to another availability domain if needed.

    Note the following:

    • In a region that has a single availability domain, only one subnet value can be provided.
    • If a regional subnet is specified, then only one subnet value can be provided.
    • If a subnet that is scoped for an availability domain is specified, then two subnet values must be provided. For each Oracle-managed load balancer node, use a subnet from a different availability domain. For one of the nodes, Oracle recommends using a subnet from the same availabilityDomain as specified for the service instance. This ensures that, as long as the service instance is running, the applications deployed on it remain accessible through the Oracle-managed load balancer.

Nested Schema : tags
Type: array
Groups tags for assigning to the service instance after the instance is created. If a tag does not yet assist, it will be created and then assigned to the service instance.
Show Source
Nested Schema : OTD
Type: object
Properties for the Oracle Traffic Director (OTD) component.
Show Source
  • Password for the Oracle Traffic Director administrator. The password must meet the following requirements:
    • Starts with a letter
    • Is between 8 and 30 characters long
    • Has one or more upper case letters
    • Has one or more lower case letters
    • Has one or more numbers
    • Has one or more of the following special characters: hyphen (-), underscore (_), pound sign (#), dollar sign ($). If Exadata is the database for the service instance, the password cannot contain the dollar sign ($).

    If an administrator password is not explicitly set, the OTD administrator password defaults to the WebLogic Server (WLS) administrator password.

  • Port for accessing Oracle Traffic Director using HTTP. The default value is 8989.
  • User name 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 (?).

    If a username is not explicitly set, the OTD user name defaults to the WebLogic Server (WLS) administrator user name.

  • Flag that specifies whether HA is enabled on the user-managed load balancer. This value defaults to false (that is, HA is not enabled).
  • ipReservations
    This attribute is not applicable to Oracle Java Cloud Service instances on Oracle Cloud Infrastructure.

    Reserved or pre-allocated IP addresses can be assigned to user-managed 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 Java 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 a Java Cloud Service with Database Exadata Cloud Service (MOS Note 2163568.1).

  • Listener port for the user-managed 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 load balancer is disabled.

  • Flag that specifies whether the non-secure listener port is enabled on the user-managed load balancer. The default value is true.
  • Policy to use for routing requests to the user-managed 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 user-managed load balancer is disabled.

    To disable the privileged listener port, set the value to 0. In this case, if the user-managed 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 user-managed load balancer is disabled.

    To disable the privileged listener port, set the value to 0. In this case, if the user-managed 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 user-managed load balancer is disabled.

  • Desired compute shape for the local balancer nodes. A shape defines the number of Oracle Compute Units (OCPUs) and amount of memory (RAM).

    On Oracle Cloud Infrastructure, VM.Standard and BM.Standard shapes, and VM.Standard.E3.Flex, VM.Standard.E4.Flex, and VM.Standard3.Flex shapes are supported.

    You can specify the number of OCPUs for the flex shapes. The maximum number of OCPUs for VM.Standard.E3.Flex and VM.Standard.E4.Flex is 64 OCPUs, and the maximum number of OCPUs for VM.Standard3.Flex is 32 OCPUs. The amount of memory is calculated based on the number of OCPUs as n*16, where n is the number of OCPUs.

    Available shapes vary depending on your Oracle Cloud account and the region in which you provision a service instance.

    See Compute Shapes in the Oracle Cloud Infrastructure documentation.

    On Oracle Cloud Infrastructure Classic, valid 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
    • oc8: 24 OCPUs, 180 GB memory
    • oc9: 32 OCPUs, 240 GB memory
    • 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
    • oc8m: 24 OCPUs, 360 GB memory
    • oc9m: 32 OCPUs, 480 GB memory

    Note: Some shapes might not be available in a region.

Nested Schema : WLS
Type: object
Properties for the Oracle WebLogic Server (WLS) component.
Show Source
  • Password for the WebLogic Server administrator. The password must meet the following requirements:
    • Starts with a letter
    • Is between 8 and 30 characters long
    • Has at least one number
    • Has one or more of the following special characters: underscore (_), pound sign (#), dollar sign ($).

    If you are using an Oracle Database Exadata Cloud Service database deployment in dbServiceName, note that the password cannot contain the dollar sign ($) but it can contain the hyphen (-). In addition, there must be 1 uppercase character and 1 lowercase character.

  • 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.

  • User name 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 (?).
  • appDBs
    Groups details of database deployments that host application schemas, if any are used.

    Applicable only if you provision a service instance with the associated infrastructure schema database on Oracle Database Cloud Service (Classic).

  • This optional attribute is applicable only if you provision an Oracle Java Cloud Service instance on Oracle Cloud Infrastructure with the associated infrastructure schema database deployed on Oracle Autonomous Transaction Processing.

    Level of performance and concurrency for Autonomous Transaction Processing.

    Possible values are:

    • high - (Do not use if the CPU Core count is greater than 1) Provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements.
    • medium - (Do not use if the CPU Core count is greater than 1) Provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements.
    • low - (Default) Provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.
    • tp - Provides a typical application connection service for transaction processing operations. This connection service does not run with parallelism.
    • tpurgent - Provides the highest priority application connection service for time critical transaction processing operations. This connection service supports manual parallelism.

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

    Name of the infrastructure schema database deployment.

    See also atpDBLevel.

    Other database restrictions may apply. See the following:

  • Size of the backup volume for the service. The value must be a multiple of GBs. You can specify this value in bytes or GBs. If specified in GBs, use the following format: nG, where n specifies the number of GBs. For example, you can express 10 GBs as bytes or GBs. For example: 100000000000 or 10G. This value defaults to the system configured volume size.
  • This attribute is ignored if clusters array is used.

    Name of the WebLogic Server application cluster that contains the Managed Servers for running the service applications.

    The cluster name:

    • Must not exceed 50 characters.
    • Must start with a letter.
    • Must contain only alphabetical characters, underscores (_), or dashes (-).
    • Must not contain any other special characters.
    • Must be unique within the identity domain.
    If no value is specified, the name of the cluster will be generated from the first eight characters of the Oracle Java Cloud Service instance name (specified in serviceName), using the following format: first8charsOfServiceInstanceName_cluster

    Note: If you provision an Oracle Java Cloud Service instance with the associated infrastructure schema database deployed on Oracle Cloud Infrastructure Database (DB system) using Oracle Real Application Clusters (RAC) technology, specify a cluster name. Doing so ensures the DB cluster service is started for the RAC DB.

  • clusters
    Groups properties for one or more clusters.

    This attribute is optional for the WebLogic Server application cluster. You must, however, use the clusters array if you want to define a caching (data grid) cluster for the service instance.

  • Connection string for the infrastructure schema database.

    On Oracle Cloud Infrastructure: This attribute is required if you provision an Oracle Java Cloud Service instance with the associated infrastructure schema database deployed on Oracle Cloud Infrastructure Database (DB system).

    The connection string is a concatenation of the Hostname Prefix and Host Domain Name.

    For a virtual machine (VM) or Exadata DB system, note that -scan must be appended to the Hostname Prefix.

    For a bare metal DB system, you do not have to append -scan.

    To construct the connection string, find the values of Hostname Prefix and Host Domain Name on the Oracle Cloud Infrastructure console. Select Bare Metal, VM, and Exadata (under Database), select the compartment, and click the DB system name you want to use.

    The connection string must be entered in one of these formats (depending on the DB system type):

    • //hostname-scan.networkdomain:1521/pdbname.networkdomain
    • //hostname.networkdomain:1521/pdbname.networkdomain

    Where:

    • hostname is the Hostname Prefix. For example: mydb1
    • networkdomain is the Host Domain Name. For example: sub1220.myvcn.oraclevcn.com
    • pdbname is the PDB name you provided when you created the 12c or later DB system. For example: PDB1

      If a PDB name was not specified when you launched the 12c or later DB system, then pdbname is the DB name appended with _PDB1. For example: mydbname_PDB1

    VM or Exadata DB system 12c or later examples: (-scan appended to the Hostname Prefix)

    //mydb1-scan.sub1220.myvcn.oraclevcn.com:1521/PDB1.sub1220.myvcn.oraclevcn.com

    //mydb1-scan.sub1220.myvcn.oraclevcn.com:1521/mydbname_PDB1.sub1220.myvcn.oraclevcn.com

    Bare metal DB system 12c or later examples: (-scan is not appended to the Hostname Prefix)

    //mydb1.sub1220.myvcn.oraclevcn.com:1521/PDB1.sub1220.myvcn.oraclevcn.com

    //mydb1.sub1220.myvcn.oraclevcn.com:1521/mydbname_PDB1.sub1220.myvcn.oraclevcn.com

    Other database restrictions may apply. See the following:

    On Oracle Cloud Infrastructure Classic: This attribute is required if you specify a BASIC service level of Database Cloud Service in dbServiceName. It is used to connect to the database deployment on Database Cloud Service - Virtual Image.

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

    • host:port:SID
    • host:port/serviceName

    For example:

    example.com:1521:orcl or example.com:1521/mydbservice

  • 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 load balancer is configured and enabled, this value has no effect.

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

  • User name for the database administrator.

    This value must not be SYSTEM. Specify a database user that has been granted the SYSDBA privilege. For service instances based on Oracle WebLogic Server 12c (any version), you can use the database user SYS.

    On Oracle Cloud Infrastructure: This value is always ADMIN if using an infrastructure schema database that is deployed on Oracle Autonomous Transaction Processing.

  • Password for the database administrator that was specified when the infrastructure schema database was created.
  • Name of the infrastructure schema database deployment on Oracle Database Cloud Service (Classic) or Oracle Database Exadata Cloud Service.

    On Oracle Cloud Infrastructure: This attribute is required only if you are using Oracle Database Cloud Service (Classic) for the infrastructure schema database. See atpDBName and connectString if you are not using Oracle Database Cloud Service (Classic).

    On Oracle Cloud Infrastructure Classic: This attribute is required.

    Other database restrictions may apply. See the following:

  • Port for accessing the WebLogic Administration Server using WLST. The default value is 9001.
  • Mode of the domain. Valid values include: DEVELOPMENT and PRODUCTION. The default value is PRODUCTION.
  • Name of the WebLogic domain. By default, the domain name will be generated from the first eight characters of the Oracle Java Cloud Service instance name (serviceName), using the following format: first8charsOfServiceInstanceName_domain

    By default, the Managed Server names will be generated from the first eight characters of the domain name name (domainName), using the following format: first8charsOfDomainName_server_n, where n starts with 1 and is incremented by 1 for each additional Managed Server to ensure each name is unique.

  • Number of partitions to enable in the domain for WebLogic Server 12.2.1. Valid values include: 0 (no partitions), 1, 2, and 4.

    Must be 0 if you are provisioning an Oracle Java Cloud Service instance for an Oracle Fusion Middleware product (WCP or ODI).

  • Size of the domain volume for the service. The value must be a multiple of GBs.

    You can specify this value in bytes or GBs. If specified in GBs, use the following format: nG, where n specifies the number of GBs. For example, you can express 10 GBs as bytes or GBs. For example: 100000000000 or 10G.

    This value defaults to the system configured volume size.

  • ipReservations
    This attribute is not applicable to Oracle Java 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 Java 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 a Java Cloud Service with Database Exadata Cloud Service (MOS Note 2163568.1).

  • This attribute is applicable only to provisioning on Oracle Cloud Infrastructure.

    This attribute is required if you provision an Oracle Java 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.

    Default is false. Set to true if the database system is a RAC database. See also ociRacDBName.

    Other database restrictions may apply. See the following:

  • Number of Managed Servers in the WebLogic Server application cluster. This attribute is ignored if clusters array is used.

    Valid values include: 1, 2, 4, and 8. The default value is 1.

  • Initial Java heap size (-Xms) for a Managed Server JVM, specified in megabytes. The value must be greater than -1.

    If you specify this initial value, a value greater than 0 (zero) must also be specified for msMaxHeapMB, msMaxPermMB, and msPermMB. In addition, msInitialHeapMB must be less than msMaxHeapMB, and msPermMB must be less than msMaxPermMB.

  • One or more Managed Server JVM arguments separated by a space.

    You cannot specify any arguments that are related to JVM heap sizes and PermGen spaces (for example, -Xms, -Xmx, -XX:PermSize, and -XX:MaxPermSize).

    A typical use case would be to set Java system properties using -Dname=value (for example, -Dmyproject.debugDir=/var/myproject/log).

    You can overwrite or append the default JVM arguments, which are used to start Managed Server processes. See overwriteMsJvmArgs for information on how to overwrite or append the server start arguments.

  • Maximum Java heap size (-Xmx) for a Managed Server JVM, specified in megabytes. The value must be greater than -1.

    If you specify this maximum value, a value greater than 0 (zero) must also be specified for msInitialHeapMB, msMaxPermMB, and msPermMB. In addition, msInitialHeapMB must be less than msMaxHeapMB, and msPermMB must be less than msMaxPermMB.

  • Maximum Permanent Generation (PermGen) space in Java heap memory (-XX:MaxPermSize) for a Managed Server JVM, specified in megabytes. The value must be greater than -1.

    Not applicable for a WebLogic Server 12.2.1 instance, which uses JDK 8.

    If you specify this maximum value, a value greater than 0 (zero) must also be specified for msInitialHeapMB, msMaxHeapMB, and msPermMB. In addition, msInitialHeapMB must be less than msMaxHeapMB, and msPermMB must be less than msMaxPermMB.

  • Initial Permanent Generation (PermGen) space in Java heap memory (-XX:PermSize) for a Managed Server JVM, specified in megabytes. The value must be greater than -1.

    Not applicable for a WebLogic Server 12.2.1 instance which uses JDK 8.

    If you specify this initial value, a value greater than 0 (zero) must also be specified for msInitialHeapMB, msMaxHeapMB, and msMaxPermMB. In addition, msInitialHeapMB must be less than msMaxHeapMB, and msPermMB must be less than msMaxPermMB.

  • Size of the MW_HOME disk volume for the service (/u01/app/oracle/middleware). The value must be a multiple of GBs. You can specify this value in bytes or GBs. If specified in GBs, use the following format: nG, where n specifies the number of GBs. For example, you can express 10 GBs as bytes or GBs. For example: 100000000000 or 10G. This value defaults to the system configured volume size.
  • Password for the Node Manager. This value defaults to the WebLogic Server administrator password (adminPassword) if no value is supplied.
  • 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.

  • User name for the Node Manager. This value defaults to the WebLogic Server administrator user name (adminUserName) if no value is supplied.
  • This attribute is applicable only to provisioning Oracle Java Cloud Service instances on Oracle Cloud Infrastructure.

    This attribute is required if isOciRacDb is set to true during provisioning.

    The DB name of the associated infrastructure schema database that uses Oracle Real Application Clusters (RAC) technology.

    Other database restrictions may apply. See the following:

  • Flag that determines whether the user defined Managed Server JVM arguments specified in msJvmArgs should replace the server start arguments (true), or append the server start arguments (false). Default is false.

    The server start arguments are calculated automatically by Oracle Java Cloud Service from site default values.

    If you append (that is, overwriteMsJvmArgs is false or is not set), the user defined arguments specified in msJvmArgs are added to the end of the server start arguments. If you overwrite (that is, set overwriteMsJvmArgs to true), the calculated server start arguments are replaced.

  • 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.

    Note: This value does not apply to Oracle Database 11g.

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

    If a 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 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 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 load balancer is not provisioned, this value defaults to securedContentPort, if specified, or 8002.

  • Flag that specifies whether to automatically deploy and start the sample application, sample-app.war, to the default Managed Server in your service instance. The default value is false.See About the Sample Application Deployed to an Oracle Java Cloud Service Instance in Administering Oracle Java Cloud Service.
  • 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 load balancer is configured and enabled, this value has no effect.

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

  • Desired compute shape for the nodes in the cluster. A shape defines the number of Oracle Compute Units (OCPUs) and amount of memory (RAM).

    On Oracle Cloud Infrastructure, VM.Standard and BM.Standard shapes, and VM.Standard.E3.Flex, VM.Standard.E4.Flex, and VM.Standard3.Flex shapes are supported.

    You can specify the number of OCPUs for the flex shapes. The maximum number of OCPUs for VM.Standard.E3.Flex and VM.Standard.E4.Flex is 64 OCPUs, and the maximum number of OCPUs for VM.Standard3.Flex is 32 OCPUs. The amount of memory is calculated based on the number of OCPUs as n*16, where n is the number of OCPUs.

    Available shapes vary depending on your Oracle Cloud account and the region in which you provision a service instance.

    See Compute Shapes in the Oracle Cloud Infrastructure documentation.

    On Oracle Cloud Infrastructure Classic, valid 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
    • oc8: 24 OCPUs, 180 GB memory
    • oc9: 32 OCPUs, 240 GB memory
    • 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
    • oc8m: 24 OCPUs, 360 GB memory)
    • oc9m: 32 OCPUs, 480 GB memory

    Note: Some shapes might not be available in a region.

  • This attribute is not applicable if using an Oracle Autonomous Transaction Processing database to host the associated infrastructure schema.

    This attribute is required only if you are provisioning an Oracle Java Cloud Service instance for an Oracle Fusion Middleware product.

    The Oracle Fusion Middleware product installer to add to this Oracle Java Cloud Service instance. Valid values are:

    • ODI - Oracle Data Integrator
    • WCP - Oracle WebCenter Portal

    To use upperStackProductName, you must specify:

    • 12cRelease214 as the WebLogic Server software serviceVersion when provisioning on Oracle Cloud Infrastructure and Oracle Cloud Infrastructure Classic
    • EE or SUITE as the edition
    • PAAS as the serviceLevel
    • 0 as the domainPartitionCount

    After the service instance is provisioned, the specified Fusion Middleware product installer is available in /u01/zips/upperstack on the Administration Server virtual machine. To install the product over the provisioned domain, follow the instructions provided by the Oracle product's installation and configuration documentation.

    Note: Patching is not supported for Oracle Java Cloud Service instances if you have installed any product that modifies MW_HOME (such as Oracle WebCenter Portal and Oracle Data Integrator). Patching is also not supported if you are reusing a license via the Bring Your Own License (BYOL) entitlement (for any product that modifies MW_HOME). Because patching replaces the contents of MW_HOME, patching prechecks flag this condition and patching fails.

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

Reserved or pre-allocated IP addresses can be assigned to user-managed 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 Java 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 a Java Cloud Service with Database Exadata Cloud Service (MOS Note 2163568.1).

Show Source
Nested Schema : appDBs
Type: array
Groups details of database deployments that host application schemas, if any are used.

Applicable only if you provision a service instance with the associated infrastructure schema database on Oracle Database Cloud Service (Classic).

Show Source
  • appDBsm
    Applicable only when the associated infrastructure schema database type is Oracle Database Cloud Service (Classic).

    Details of a database deployment that is used to host application schemas (if used). You can specify up to four application schema database deployments. The application schema databases can be created using Oracle Database 11g Release 2, Oracle Database 12c Release 1, or Oracle Database 12c Release 2.

Nested Schema : clusters
Type: array
Groups properties for one or more clusters.

This attribute is optional for the WebLogic Server application cluster. You must, however, use the clusters array if you want to define a caching (data grid) cluster for the service instance.

Show Source
  • clusters-array
    Properties for WebLogic Server clusters.

    One to eight application clusters can be specified.

    Only one caching (data grid) cluster can be specified. You must use the clusters array if you want to include a caching (data grid) cluster for the service instance.

Nested Schema : ipReservations
Type: array
This attribute is not applicable to Oracle Java 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 Java 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 a Java Cloud Service with Database Exadata Cloud Service (MOS Note 2163568.1).

Show Source
Nested Schema : appDBsm
Type: object
Applicable only when the associated infrastructure schema database type is Oracle Database Cloud Service (Classic).

Details of a database deployment that is used to host application schemas (if used). You can specify up to four application schema database deployments. The application schema databases can be created using Oracle Database 11g Release 2, Oracle Database 12c Release 1, or Oracle Database 12c Release 2.

Show Source
  • User name for the database administrator.

    This value must not be SYSTEM. Specify a database user that has been granted the SYSDBA privilege. For service instances based on Oracle WebLogic Server 12c (any version), you can use the database user SYS.

  • Database administrator password that was specified when the database deployment was created.
  • Name of the database deployment to use. The specified database deployment must be running.

    The same database deployment can be used for multiple appDBs associations. The same database deployment can be used for both the required infrastructure schema database and optional application schema databases.

  • Name of the pluggable database for Oracle Database 12c. If not specified, the pluggable database name configured when the database was created will be used.

    Note: This value does not apply to Oracle Database 11g.

Nested Schema : clusters-array
Type: object
Properties for WebLogic Server clusters.

One to eight application clusters can be specified.

Only one caching (data grid) cluster can be specified. You must use the clusters array if you want to include a caching (data grid) cluster for the service instance.

Show Source
  • Name of the cluster to create.

    The cluster name:

    • Must not exceed 50 characters.
    • Must start with a letter.
    • Must contain only alphabetical characters, underscores (_), or dashes (-).
    • Must not contain any other special characters.
    • Must be unique within the identity domain.

  • pathPrefixes
    A single path prefix or multiple path prefixes separated by commas. A path prefix must be unique across clusters in the domain.

    This attribute is only applicable to service instances where an Oracle-managed load balancer is configured. It is also only applicable to a cluster of type APPLICATION_CLUSTER.

    When path prefixes are specified, this means the load balancer can route to only those applications that have the context root matching one of the path prefixes.

    For example, if you specified the following path prefixes:

    ["/myapp1", "/myapp2"]

    ...then the load balancer can route to only those applications that have the context root matching these:

    • /myapp1
    • /myapp1/*
    • /myapp2
    • /myapp2/*

  • Number of servers to create in this cluster.
    • For APPLICATION_CLUSTER - Valid values include: 1, 2, 4, and 8. The default value is 1.
    • For CACHING_CLUSTER - Use a number from 1 to 32 only. The default value is 1.

      The serverCount limit is based on the VM (cluster size) limit of four and the serversPerNode limit of eight.

      Note: The actual server number is rounded up to fill the number of nodes required to create the caching cluster. For example, if serversPerNode is four and serverCount is three, the actual number of servers that will be created is four.

  • Number of JVMs to start on each VM (node). This attribute is only applicable to cluster type CACHING_CLUSTER.

    Use a number from 1 to 8 only. The default value is 1.

  • Desired compute shape for the nodes in this cluster. A shape defines the number of Oracle Compute Units (OCPUs) and amount of memory (RAM).

    This shape attribute is optional. If no shape value is specified here, the shape is inherited from the WLS component level shape.

    On Oracle Cloud Infrastructure, VM.Standard and BM.Standard shapes, and VM.Standard.E3.Flex, VM.Standard.E4.Flex, and VM.Standard3.Flex shapes are supported.

    You can specify the number of OCPUs for the flex shapes. The maximum number of OCPUs for VM.Standard.E3.Flex and VM.Standard.E4.Flex is 64 OCPUs, and the maximum number of OCPUs for VM.Standard3.Flex is 32 OCPUs. The amount of memory is calculated based on the number of OCPUs as n*16, where n is the number of OCPUs.

    Available shapes vary depending on your Oracle Cloud account and the region in which you provision a service instance.

    See Compute Shapes in the Oracle Cloud Infrastructure documentation.

    On Oracle Cloud Infrastructure Classic, valid 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
    • oc8: 24 OCPUs, 180 GB memory
    • oc9: 32 OCPUs, 240 GB memory
    • 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
    • oc8m: 24 OCPUs, 360 GB memory
    • oc9m: 32 OCPUs, 480 GB memory

    Note: Some shapes might not be available in a region.

  • Type of cluster to create. Valid values include:
    • APPLICATION_CLUSTER - Application cluster (default). This is the WebLogic cluster that will run the service applications, which are accessible via the user-managed load balancer resource (OTD) or the Oracle-managed load balancer.
    • CACHING_CLUSTER - Caching (data grid) cluster. This is the WebLogic cluster for Coherence storage.
Nested Schema : pathPrefixes
Type: array
A single path prefix or multiple path prefixes separated by commas. A path prefix must be unique across clusters in the domain.

This attribute is only applicable to service instances where an Oracle-managed load balancer is configured. It is also only applicable to a cluster of type APPLICATION_CLUSTER.

When path prefixes are specified, this means the load balancer can route to only those applications that have the context root matching one of the path prefixes.

For example, if you specified the following path prefixes:

["/myapp1", "/myapp2"]

...then the load balancer can route to only those applications that have the context root matching these:

  • /myapp1
  • /myapp1/*
  • /myapp2
  • /myapp2/*

Show Source
Nested Schema : subnets
Type: array
This attribute is available only on Oracle Cloud Infrastructure.

This attribute is required if you are provisioning an Oracle Java Cloud Service instance on a specific subnet using subnet.

Subnets for the Oracle-managed load balancer nodes (node 1 and node 2).

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

Oracle recommends that you use a regional subnet for the load balancer to support failover to another availability domain if needed.

Note the following:

  • In a region that has a single availability domain, only one subnet value can be provided.
  • If a regional subnet is specified, then only one subnet value can be provided.
  • If a subnet that is scoped for an availability domain is specified, then two subnet values must be provided. For each Oracle-managed load balancer node, use a subnet from a different availability domain. For one of the nodes, Oracle recommends using a subnet from the same availabilityDomain as specified for the service instance. This ensures that, as long as the service instance is running, the applications deployed on it remain accessible through the Oracle-managed load balancer.

Show Source
Nested Schema : tagsassign-provision
Type: object
Each tag is a key/value pair.

For account non-metering tags, specify an existing tag key and value for assignment.

Show Source
  • Specify the key for this tag. A tag key can contain letters, numbers, dashes (-), and underscores ( _ ), and it can contain up to 128 characters.
  • Specify the value for this tag. A tag value can contain up to 256 characters and is case-sensitive.

    Default value is an empty string (if you do not provide a specific value).

Back to Top

Response

Supported Media Types

202 Response

Accepted. The Location header returns a URI that can be used to view the job status. See View the Status of an Operation by Job Id.
Body ()
Root Schema : accepted-responsem
Type: object
The response body contains information about the operation. It can include an issues array for warning messages.
Show Source
Nested Schema : details
Type: object
Groups details of the operation.
Show Source
Nested Schema : issues
Type: array
Groups strings of warning messages, if any.
Show Source

400 Response

Bad Request. Returned if the request payload contains bad or missing details.

See Status Codes for information about other possible HTTP status codes.

Body ()
Root Schema : badrequest-responsem
Type: object
The response body contains information about the request. It can include an issues array for validation error messages.
Show Source
Nested Schema : details
Type: object
Groups details of the request.
Show Source
Nested Schema : issues
Type: array
Groups strings of validation error messages, if any.
Show Source
Back to Top

Examples

The following example shows how to create an Oracle Java Cloud Service instance by submitting a POST request on the REST resource using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command

curl -i -X POST -u username:password -d @createservice.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances

Example of Request Body (Oracle Cloud Infrastructure)

The following is an example of a request body for creating a service instance on Oracle Cloud Infrastructure. The service instance uses the Oracle-managed load balancer; it is associated with an Oracle Autonomous Transaction Processing database. 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.

{
   "subnet":"ocid1.subnet.123longstring",
   "enableAdminConsole":"true",
   "components":{
      "WLS":{
         "domainPartitionCount":"0",
         "adminUserName":"yourWLSAdminUserName",
         "atpDBName":"youratpdbname",
         "atpDBLevel":"low",
         "dbaPassword":"yourdbapassword",
         "dbaName":"ADMIN",
         "sampleAppDeploymentRequested":"true",
         "clusters":[
            {
               "serverCount":"1",
               "shape":"VM.Standard2.1",
               "clusterName":"instance_cluster",
               "type":"APPLICATION_CLUSTER"
            }
         ],
         "adminPassword":"yourWLSAdminPassword"
      }
   },
   "availabilityDomain":"QnsC:US-ASHBURN-AD-1",
   "edition":"EE",
   "vmPublicKeyText":"yourSSHPublicKeyString",
   "serviceLevel":"PAAS",
   "serviceName":"ExampleInstance",
   "enableNotification":"true",
   "notificationEmail":"youremail",
   "backupDestination":"NONE",
   "serviceVersion":"12cRelease214",
   "configureLoadBalancer": "true",
   "loadbalancer":{
      "subnets":[
         "ocid1.subnet.456longstring",
         "ocid1.subnet.789longstring"
      ],
      "loadBalancingPolicy":"ROUND_ROBIN"
   },
   "region":"us-ashburn-1",
   "isBYOL":"false"
}
The following is an example of the request body for creating a service instance using flexible shapes on Oracle Cloud Infrastructure in JSON format. The service instance uses the OTD load balancer; it is associated with an Oracle Cloud Infrastructure VM Database system. 
{
   "subnet":"ocid1.subnet.oc1.1231ongstring",
   "enableAdminConsole":"true",
   "components":{
      "OTD":{
         "shape":"VM.Standard.E3.Flex{ocpu:2}",
         "loadBalancingPolicy":"LEAST_CONNECTION_COUNT",
         "haEnabled":"false"
      },
      "WLS":{
         "domainPartitionCount":"0",
         "adminUserName":"yourWLSAdminUserName",
         "isOciRacDb":"false",
         "dbType":"OCINativeDB",
         "dbaPassword":"yourdbapassword",
         "dbaName":"SYS",
         "pdbServiceName":"pdb1",
         "connectString":"//yourhostname-scan.yournetworkdomain:1521/pdb1.yournetworkdomain",
         "sampleAppDeploymentRequested":"true",
         "shape":"VM.Standard.E3.Flex{ocpu:2}",
         "adminInitialHeapMB":"1024",
         "adminMaxHeapMB":"1024",
         "msInitialHeapMB":"4096",
         "msMaxHeapMB":"4096",
         "clusters":[
            {
               "serverCount":"1", 
               "clusterName":"yourClusterName",
               "type":"APPLICATION_CLUSTER"
            }
         ],
         "adminPassword":"yourWLSAdminPassword"
      }
   },
   "availabilityDomain":"KiJR:PHX-AD-1",
   "edition":"EE",
   "vmPublicKeyText":"yourSSHPublicKeyString",
   "serviceLevel":"PAAS",
   "serviceName":"ExampleInstance",
   "backupDestination":"NONE",
   "serviceVersion":"12cRelease214",
   "enableNotification":"false",
   "meteringFrequency":"HOURLY",
   "region":"us-phoenix-1",
   "subscriptionId":"20170102",
   "loadBalancerOption":"OTD",
   "isBYOL":"true"
}

The following is an example of a request body for creating a service instance on Oracle Cloud Infrastructure. The service instance uses the Oracle-managed load balancer; it is associated with an Oracle Cloud Infrastructure VM Database system. Note that -scan is appended to the hostname prefix for a VM DB system. 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. 

{
   "region":"us-ashburn-1",
   "availabilityDomain":"NsfH:US-ASHBURN-AD-1",
   "subnet":"ocid1.subnet.123longstring",
   "edition":"EE",
   "vmPublicKeyText":"yourSSHPublicKeyString",
   "enableNotification":"true",
   "notificationEmail":"youremail",
   "backupDestination":"NONE",
   "serviceVersion":"12cRelease214",
   "serviceLevel":"PAAS",
   "serviceName":"ExampleInstance2",
   "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":[
            {
               "clusterName":"myapp_cluster",
               "serverCount":"1",
               "shape":"VM.Standard2.1",
               "type":"APPLICATION_CLUSTER"
            }
         ],
         "sampleAppDeploymentRequested":"true"
      }
   },
   "configureLoadBalancer": "true",
   "loadbalancer":{
      "subnets":[
         "ocid1.subnet.456longstring",
         "ocid1.subnet.789longstring"
      ],
      "loadBalancingPolicy":"ROUND_ROBIN"
   },
   "enableAdminConsole":"true",
   "meteringFrequency":"HOURLY"
}

The following is an example of a simple request body for creating a single-node instance without any load balancer on Oracle Cloud Infrastructure. The instance is associated with Oracle Database Cloud Service (Classic).

{
  "serviceLevel": "PAAS",
  "serviceName": "JCS1onOCI",
  "edition": "EE",
  "serviceDescription": "My JCS instance on Oracle Cloud Infrastructure",
  "serviceVersion": "12cRelease214",
  "region": "us-phoenix-1",
  "availabilityDomain": "QnsC:PHX-AD-1",
  "subnet": "ocid1.subnet.1long2string3",
  "cloudStorageContainer": "https://swiftobjectstorage.us-phoenix-1.oraclecloud.com/v1/acme/mybucket",
  "cloudStorageUser": "yourObjectStorageUser",
  "cloudStoragePassword": "yourSwiftPasswordGeneratedInOracleCloudInfrastructure",
  "vmPublicKeyText": "yourSSHPublicKeyString",
  "enableAdminConsole":"true",
  "components": {
    "WLS": {
      "adminUserName": "yourWLSAdminUserName",
      "adminPassword": "yourWLSAdminPassword",
      "managedServerCount": "1",
      "clusterName": "jcs1_cluster",
      "dbaName": "yourDBUserName",
      "dbaPassword": "yourDBCSPassword",
      "dbServiceName": "DBCS1",
      "shape": "VM.Standard2.1"
    }
  }
}

Example of Request Body (Oracle Cloud Infrastructure Classic and Oracle Cloud at Customer)

The following is an example of the request body in JSON format. It uses the clusters array to define one application tier cluster and one Coherence data tier cluster. 

{
    "cloudStorageContainer" : "yourObjectStorageContainer",
    "cloudStorageUser" : "yourObjectStorageUser",
    "cloudStoragePassword" : "yourObjectStoragePassword",
    "cloudStorageContainerAutoGenerate" : true,
    "serviceDescription" : "My service instance using the new path and parameters",
    "serviceLevel" : "PAAS",
    "serviceName" : "MyFirstInstance",
    "edition" : "SUITE",
    "serviceVersion" : "12cR4",
    "meteringFrequency" : "HOURLY",
    "provisionOTD" : true,
    "enableAdminConsole" : true,
    "vmPublicKeyText" : "yourSSHPublicKeyString",
    "components" : {
        "WLS" : {
            "shape" : "oc3",
            "managedServerCount": 0,
            "clusters" : [
                {
                    "clusterName" : "yourClusterName",
                    "type": "APPLICATION_CLUSTER",
                    "serverCount" : 2
                },
                {
                    "clusterName" : "yourCoherenceClusterName",
                    "type": "CACHING_CLUSTER",
                    "serverCount" : 3,
                    "serversPerNode" : 4,
                    "shape" : "oc3"
                }
            ],
            "adminUserName" : "yourWLSAdminUserName",
            "adminPassword" : "yourWLSAdminPassword",
            "sampleAppDeploymentRequested" : true,
            "domainMode" : "PRODUCTION",
            "dbServiceName" : "yourDBCSName",
            "dbaName" : "yourDBUserName",
            "dbaPassword" : "yourDBCSPassword",
            "appDBs" : [
                {
                    "dbServiceName" : "yourAppDBService",
                    "dbaName" : "yourAppDBUserName",
                    "dbaPassword" : "yourAppDBPassword"
                }
            ]
        },
        "OTD": {
            "adminUserName" : "yourOTDUserName",
            "adminPassword" : "yourOTDPassword",
            "listenerPortEnabled" : true,
            "listenerPort" : "8080",
            "securedListenerPort" : "8081",
            "loadBalancingPolicy" : "LEAST_CONNECTION_COUNT",
            "haEnabled" : false,
            "adminPort" : "8989",
            "shape" : "oc3"
        }
    }
}

The following is a request body that uses a region and IP reservations for the WLS and OTD nodes. Note that IP reservations are not applicable when creating service instances in Oracle Cloud Infrastructure.

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. 

{
    "cloudStorageContainer" : "yourObjectStorageContainer",
    "cloudStorageUser" : "yourObjectStorageUser",
    "cloudStoragePassword" : "yourObjectStoragePassword",
    "cloudStorageContainerAutoGenerate" : true,
    "serviceDescription" : "My service instance using the new path and parameters",
    "serviceLevel" : "PAAS",
    "serviceName" : "MyFirstInstance",
    "edition" : "EE",
    "serviceVersion" : "12cR4",
    "meteringFrequency" : "HOURLY",
    "provisionOTD" : true,
    "enableAdminConsole" : true,
    "vmPublicKeyText" : "yourSSHPublicKeyString",
    "region" : "uscom-central-1",
    "components" : {
        "WLS" : {
            "adminUserName" : "yourWLSAdminUserName",
            "adminPassword" : "yourWLSAdminPassword",
            "sampleAppDeploymentRequested" : true,
            "domainMode" : "PRODUCTION",
            "dbServiceName" : "yourDBCSName",
            "dbaName" : "yourDBUserName",
            "dbaPassword" : "yourDBCSPassword",
            "clusterName" : "yourClusterName",
            "managedServerCount" : 2,
            "ipReservations": ["ipres01, ipres02"],
            "shape" : "oc3",
            "appDBs": [
            {
                "dbaPassword": "yourAppDBUserPassword",
                "dbServiceName": "yourAppDBCSName",
                "dbaName": "yourAppDBUserName"
            }]
        },
        "OTD": {
            "adminUserName" : "yourOTDUserName",
            "adminPassword" : "yourOTDPassword",
            "listenerPortEnabled" : true,
            "listenerPort" : "8080",
            "securedListenerPort" : "8081",
            "loadBalancingPolicy" : "LEAST_CONNECTION_COUNT",
            "haEnabled": "false",
            "ipReservations": ["ipres03"],
            "adminPort" : "8989",
            "shape" : "oc3"
        }
    }
}

Example of Request Body for Cloning an Instance

sourceServiceName and snapshotName are required for creating a clone of a service instance. You must also use a clone of the associated Oracle Cloud database deployment. 

{
  "backupDestination" : "BOTH",
  "cloudStorageContainer" : "yourObjectStorageContainer",
  "cloudStorageUser" : "yourObjectStorageUser",
  "cloudStoragePassword" : "yourObjectStoragePassword",
  "serviceDescription" : "This is a clone of the service instance MyJCSsource",
  "sourceServiceName":"MyJCSsource",
  "snapshotName":"myJCSSnapshot-1",
  "serviceName" : "CloneMyJCSsource",
  "enableAdminConsole" : true,
  "vmPublicKeyText" : "yourSSHPublicKeyString",
  "components" : {
    "WLS" : {
      "shape" : "oc4",
      "adminUserName" : "yourWLSAdminUserName",
      "adminPassword" : "yourWLSAdminPassword",
      "dbaName" : "yourDBUserName",
      "dbaPassword" : "yourDBCSPassword",
      "dbServiceName" : "yourCloneDBCSName"
    },
    "OTD" : {
      "shape" : "oc4"
    }
  }
}

Example of Changing Default Ports in Request Body

Resources available within an Oracle Java Cloud Service instance are accessible through default ports. The ports can be reconfigured when you create the service instance.

The default ports are shown in the following table. You can change the desired port values by adding the corresponding attributes to the request body.

Note: The load balancer information presented here is applicable only to Oracle Traffic Director (OTD), which can be configured as a local load balancer for the Oracle Java Cloud Service instance you are provisioning.

Ports Available from Within the Oracle Cloud Network

Resource Protocol Default Port Attribute
Oracle WebLogic Server Administration Console HTTP 7001 adminPort

(WLS)

Oracle WebLogic Server Administration Console using WLST HTTP 9001 deploymentChannelPort

(WLS)

Oracle Fusion Middleware Control HTTP 7001 adminPort

(WLS)

Ports Available from Outside the Oracle Cloud Network

Resource Protocol Default Port Attribute
Oracle WebLogic Server Administration Console HTTPS 7002 securedAdminPort

(WLS)

Oracle Fusion Middleware Control HTTPS 7002 securedAdminPort

(WLS)

Oracle Traffic Director Administration Console HTTPS 8989 adminPort

(OTD)

End-user applications when load balancer is enabled HTTP 8080 listenerPort

(OTD)

End-user applications when load balancer is enabled HTTPS 8081 securedListenerPort

(OTD)

End-user applications when load balancer is enabled Privileged HTTP (Default) 80 privilegedListenerPort

(OTD)

End-user applications when load balancer is enabled Privileged HTTPS (Default) 443 privilegedSecureddListenerPort

(OTD)

End-user applications when load balancer is disabled, single Managed Server HTTP 8001 contentPort

(WLS)

End-user applications when load balancer is disabled, single Managed Server HTTPS 8002 securedContentPort

(WLS)

End-user applications when load balancer is disabled, single Managed Server Privileged HTTP (Default) 80 privilegedContentPort

(WLS)

End-user applications when load balancer is disabled, single Managed Server Privileged HTTPS (Default) 443 privilegedSecuredContentPort

(WLS)

End-user applications when load balancer is disabled, multiple Managed Servers HTTP 8001 contentPort

(WLS)

End-user applications when load balancer is disabled, multiple Managed Servers HTTPS 8002 securedContentPort

(WLS)

If you enable OTD as a local load balancer, you can update the privileged port values by setting the privilegedListenerPort and privlegedSecuredListenerPort attributes, respectively, within the Oracle Traffic Director (OTD) component parameter grouping to the desired values. If OTD is not enabled, you can update the privileged port values by setting the privilegedContentPort and privlegedSecuredContentPort attributes, respectively, within the Oracle WebLogic Server (WLS) component parameter grouping to the desired values.

To enable the use of non-privileged ports, you must disable the use of privileged ports by setting the corresponding privileged port attributes to 0. Again, you would need to set the attribute values for both OTD and WLS to enable the use of non-privileged ports when the load balancer is available and when it is not, respectively.

The following example shows how to configure the non-privileged ports for the Oracle WebLogic Server Administration Console, Oracle Fusion Middleware Console, and the OTD load balancer.

{
    "serviceName" : "ExampleInstance",
    . . .
    "components" : {
        "WLS" : {
            ...
            "privilegedContentPort" : "0",
            "privilegedSecuredContentPort" : "0",
            "contentPort" : "8001",
            "securedContentPort" : "8002",
            ...
        },
        "OTD": {
            ...
            "listenerPortsEnabled" : true,
            "privilegedListenerPort" : "0",
            "privilegedSecuredListenerPort" : "0",
            "listenerPort" : "8080",
            "securedListenerPort" : "8081",
            ...
        }
     }
}

Example of Response Header

The following shows an example of the response header. The Location header returns the URI that can be used to view the job status. See View the Status of an Operation by Job Id. 

HTTP/1.1 202 Accepted
Location: https://rest_server/paas/api/v1.1/activitylog/yourIdentityDomain/job/5028794
Content-Language: en
Retry-After: 60
Service-URI: https://rest_server/paas/api/v1.1/instancemgmt/yourIdentityDomain/services/jaas/instances/ExampleInstance
Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json
Date: Tue, 23 May 2017 18:37:36 GMT

Example of Response Body

The following shows an example of a 202 returned in JSON format.

{
    "details": {
        "message": "Submitted job to create service [ExampleInstance] in domain [ExampleIdentityDomain].",
        "jobId": "29197083"
    }
}

The following shows an example of a 202 response that includes the issues array. 

{
   "details":{
      "message":"Submitted job to create service [ExampleInstance] in domain [ExampleIdentityDomain].",
      "jobId":"10006666",
      "issues":[
         "[The association [INFRA_DB] is mandatory for service [ExampleInstance] but it is missing]"
      ]
   }
}

The following shows an example of a 400 response returned in JSON format.

{
   "details":{
      "message":"PSM-LCM-01001 Unable to submit request to create service [ExampleInstance] in domain [ExampleIdentityDomain]. See the included validation errors for details.",
      "issues":[
         "[The value for parameter [backupDestination (foobar)] is not in the list of valid values [BOTH NONE].]"
      ]
   }
}
Back to Top