Create a Service Instance
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/DHCS/instances
Request
- application/vnd.com.oracle.oracloud.provisioning.Service+json
-
identityDomainId: string
Identity domain ID for the Oracle Data Hub Cloud Service account.
object
Request Body
-
availabilityDomain:
string
Name of the Availability Domain within the Compute Region.
-
backupDestination:
string
Backup destination.
-
cloudStorageContainer:
string
Oracle cloud storage container used for backing up the database.
-
cloudStorageContainerAutoGenerate:
string
Create cloud storage container.
-
cloudStoragePassword:
string
Cloud storage password.
-
cloudStorageUser:
string
Cloud storage username.
-
components:
object Component Parameters
Title:
Component Parameters
-
edition:
string
Select the Edition of the service to create.
-
enableNotification:
string
Select to enable email notifications for your service.
-
ipNetwork:
string
IP Network for each node in the service.
-
isActive:
string
Service is available for provisioning the topic services (applicable only if the service is Oracle Managed).
-
isBYOL:
string
Leverage your on-premises licenses aka BYOL (Oracle Database and Oracle Weblogic etc.) when spin up Cloud Service instances in the PAYG or Monthly Commit purchase models.
-
isManaged:
string
Describes if the service is Oracle Managed.
-
meteringFrequency:
string
Metering Frequency.
-
noRollback:
string
This parameter, when set to true disables rollback in case of failure - this is helpful for debugging purposes, as the resources would not get cleaned up.
-
notificationEmail:
string
Enter email address for notifications.
-
publishTo:
string
Topic services can use the underlying system which are created using the given domain (applicable only if the service is Oracle Managed).
-
region:
string
This attribute is only applicable to accounts where regions are supported, including accounts on Oracle Cloud Infrastructure.
Name of the region where the Oracle Data Hub Cloud Service instance is to be provisioned.
A region name must be specified if you intend to use
ipReservations
oripNetwork
in an Oracle Cloud Infrastructure Classic deployment.If you do not specify a region, the service instance is created on Oracle Cloud Infrastructure Classic and does not support
ipReservations
oripNetwork
.An Oracle Cloud Infrastructure region must be specified to provision your service instance on Oracle Cloud Infrastructure host 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
orus-ashburn-1.
If the default data region is EMEA, specify the region aseu-frankfurt-1
oruk-london-1.
Note the following when provisioning on Oracle Cloud Infrastructure:
An availability domain must also be specified using
availabilityDomain.
See Regions and Availability Domains in Oracle Cloud Infrastructure Services.A subnet must also be specified using subnet. See VCNs and Subnets in Oracle Cloud Infrastructure Services.
Access rules and IP reservations REST endpoints are not supported.
-
serviceDescription:
string
This is a optional description that is used to help identify the purpose for this service.
-
serviceLevel:
string
This is the level of service provided for this service.
-
serviceName:
string
This is the unique name used to identify the service in the tenant domain.
-
serviceVersion:
string
Service version of the service to create.
-
subnet:
string
This attribute is relevant to only Oracle Cloud Infrastructure. Specify the Oracle Cloud Identifier (OCID) of a subnet from a virtual cloud network (VCN) that you had created previously in Oracle Cloud Infrastructure. For the instructions to create a VCN and subnet, see Prerequisites for Oracle Platform Services on Oracle Cloud Infrastructure in the Oracle Cloud Infrastructure documentation.
The OCID is a unique autogenerated ID. To find out the OCID of a subnet, go to the Oracle Cloud Infrastructure web console, select the Networking tab, click the VCN that your subnet is in, and look for the OCID field under the subnet that you want to use.
-
useHighPerformanceStorage:
string
Use High Performance Storage for the data files.
-
vmPublicKeyText:
string
Select the public key that will be used for access to service hosts.
-
vmUser:
string
This is the virtual machine OS user that has root privilege.
object
Component Parameters
-
CASSANDRA:
object CASSANDRA
Title:
CASSANDRA
object
CASSANDRA
-
adminUserName:
string
Administrative username.
-
adminUserPassword:
string
Password for the administrative user.
-
clientPort:
string
Client connection port number.
-
clientSslPort:
string
Client SSL connection port number.
-
dataStorage:
string
Total usable data storage in GB.
-
httpPort:
string
Console HTTP connection port number.
-
httpsPort:
string
Console HTTPS connection port number.
-
ipReservations:
array ipReservations
Assign automatically or choose reserved IP(s) for nodes.
-
jmxPort:
string
JMX connection port number.
-
serverCount:
string
Number of nodes at initial startup.
-
shape:
string
Desired compute shape for the nodes in the cluster. A shape defines the number of Oracle Compute Units (OCPUs) and amount of memory (RAM).
The valid shapes on Oracle Cloud Infrastructure Classic 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
- 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
On Oracle Cloud Infrastructure, only VM.Standard and BM.Standard shapes are supported. See the Bare Metal Shapes and VM Shapes tables of the topic Overview of the Compute Service in Oracle Cloud Infrastructure Services.
array
Response
- application/json
202 Response
object
-
jobId:
string
Job ID of the operation.
-
message:
string
System message that describes the operation. For example:
Submitted job to create service [{serviceName}] in domain [{identityDomainId}].