Jump to

• Request
• Response

Create a Service Instance

post

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

Creates an Oracle Data Hub Cloud Service instance.

Request

Supported Media Types

• application/vnd.com.oracle.oracloud.provisioning.Service+json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Data Hub Cloud Service account.

Body ()

The request body defines the details of the create request.

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

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

  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 or us-ashburn-1. If the default data region is EMEA, specify the region as eu-frankfurt-1 or uk-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.

{
    "type":"object",
    "required":[
        "backupDestination",
        "edition",
        "serviceLevel",
        "serviceName",
        "serviceVersion",
        "vmPublicKeyText",
        "vmUser"
    ],
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"This is the unique name used to identify the service in the tenant domain."
        },
        "vmPublicKeyText":{
            "type":"string",
            "description":"Select the public key that will be used for access to service hosts."
        },
        "backupDestination":{
            "type":"string",
            "description":"Backup destination."
        },
        "cloudStorageContainer":{
            "type":"string",
            "description":"Oracle cloud storage container used for backing up the database."
        },
        "cloudStorageUser":{
            "type":"string",
            "description":"Cloud storage username."
        },
        "cloudStoragePassword":{
            "type":"string",
            "description":"Cloud storage password."
        },
        "cloudStorageContainerAutoGenerate":{
            "type":"string",
            "description":"Create cloud storage container."
        },
        "useHighPerformanceStorage":{
            "type":"string",
            "description":"Use High Performance Storage for the data files."
        },
        "serviceDescription":{
            "type":"string",
            "description":"This is a optional description that is used to help identify the purpose for this service."
        },
        "serviceLevel":{
            "type":"string",
            "description":"This is the level of service provided for this service."
        },
        "meteringFrequency":{
            "type":"string",
            "description":"Metering Frequency."
        },
        "serviceVersion":{
            "type":"string",
            "description":"Service version of the service to create."
        },
        "edition":{
            "type":"string",
            "description":"Select the Edition of the service to create."
        },
        "vmUser":{
            "type":"string",
            "description":"This is the virtual machine OS user that has root privilege."
        },
        "subnet":{
            "type":"string",
            "description":"<p>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 <a href=\"https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=oci_general_paasprereqs\" target=\"_blank\">Prerequisites for Oracle Platform Services on Oracle Cloud Infrastructure</a> in the Oracle Cloud Infrastructure documentation.</p><p>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 <b>Networking</b> tab, click the VCN that your subnet is in, and look for the <b>OCID</b> field under the subnet that you want to use.</p>"
        },
        "region":{
            "type":"string",
            "description":"<p>This attribute is only applicable to accounts where regions are supported, including accounts on Oracle Cloud Infrastructure.</p><p>Name of the region where the Oracle Data Hub Cloud Service instance is to be provisioned.</p><p>A region name must be specified if you intend to use <code>ipReservations</code> or <code>ipNetwork</code> in an Oracle Cloud Infrastructure Classic deployment.</p><p>If you do not specify a region, the service instance is created on Oracle Cloud Infrastructure Classic and does not support <code>ipReservations</code> or <code>ipNetwork</code>.</p><p>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 <code>us-phoenix-1</code> or <code>us-ashburn-1.</code> If the default data region is EMEA, specify the region as <code>eu-frankfurt-1</code> or <code>uk-london-1.</code></p><p>Note the following when provisioning on Oracle Cloud Infrastructure:</p><ul><li><p>An availability domain must also be specified using <code>availabilityDomain.</code> See <a href=\"https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=oci_general_regions\" target=\"_blank\">Regions and Availability Domains</a> in Oracle Cloud Infrastructure Services.</p></li><li><p>A subnet must also be specified using subnet. See <a href=\"https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=oci_network_vcns\" target=\"_blank\">VCNs and Subnets</a> in Oracle Cloud Infrastructure Services.</p></li><li><p>Access rules and IP reservations REST endpoints are not supported.</p></li></ul>"
        },
        "availabilityDomain":{
            "type":"string",
            "description":"Name of the Availability Domain within the Compute Region."
        },
        "noRollback":{
            "type":"string",
            "description":"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."
        },
        "isManaged":{
            "type":"string",
            "description":"Describes if the service is Oracle Managed."
        },
        "enableNotification":{
            "type":"string",
            "description":"Select to enable email notifications for your service."
        },
        "notificationEmail":{
            "type":"string",
            "description":"Enter email address for notifications."
        },
        "ipNetwork":{
            "type":"string",
            "description":"IP Network for each node in the service."
        },
        "isActive":{
            "type":"string",
            "description":"Service is available for provisioning the topic services (applicable only if the service is Oracle Managed)."
        },
        "publishTo":{
            "type":"string",
            "description":"Topic services can use the underlying system which are created using the given domain (applicable only if the service is Oracle Managed)."
        },
        "isBYOL":{
            "type":"string",
            "description":"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."
        },
        "components":{
            "$ref":"#/definitions/create-service-components"
        }
    },
    "title":"Request Body"
}

Nested Schema : Component Parameters

Type: object

Title: Component Parameters

Show Source

• CASSANDRA: object CASSANDRA
  Title: CASSANDRA

{
    "type":"object",
    "properties":{
        "CASSANDRA":{
            "$ref":"#/definitions/create-service-components-CASSANDRA"
        }
    },
    "title":"Component Parameters"
}

Nested Schema : CASSANDRA

Type: object

Title: CASSANDRA

Show Source

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

{
    "type":"object",
    "required":[
        "adminUserName",
        "adminUserPassword",
        "dataStorage",
        "httpPort",
        "httpsPort",
        "serverCount",
        "shape"
    ],
    "properties":{
        "shape":{
            "type":"string",
            "description":"Desired compute shape for the nodes in the cluster. A shape defines the number of Oracle Compute Units (OCPUs) and amount of memory (RAM).<p>The valid shapes on Oracle Cloud Infrastructure Classic include:</p><ul><li>oc3: 1 OCPU, 7.5 GB memory</li><li>oc4: 2 OCPUs, 15 GB memory</li><li>oc5: 4 OCPUs, 30 GB memory</li><li>oc6: 8 OCPUs, 60 GB memory</li><li>oc7: 16 OCPUs, 120 GB memory</li><li>oc1m: 1 OCPU, 15 GB memory</li><li>oc2m: 2 OCPUs, 30 GB memory</li><li>oc3m: 4 OCPUs, 60 GB memory</li><li>oc4m: 8 OCPUs, 120 GB memory</li><li>oc5m: 16 OCPUs, 240 GB memory</li></ul><p>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 <a href=\"https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=oci_compute_overview\" target=\"_blank\">Overview of the Compute Service</a> in <i>Oracle Cloud Infrastructure Services.</i></p>"
        },
        "serverCount":{
            "type":"string",
            "description":"Number of nodes at initial startup."
        },
        "dataStorage":{
            "type":"string",
            "description":"Total usable data storage in GB."
        },
        "adminUserName":{
            "type":"string",
            "description":"Administrative username."
        },
        "adminUserPassword":{
            "type":"string",
            "description":"Password for the administrative user."
        },
        "clientPort":{
            "type":"string",
            "description":"Client connection port number."
        },
        "clientSslPort":{
            "type":"string",
            "description":"Client SSL connection port number."
        },
        "jmxPort":{
            "type":"string",
            "description":"JMX connection port number."
        },
        "httpPort":{
            "type":"string",
            "description":"Console HTTP connection port number."
        },
        "httpsPort":{
            "type":"string",
            "description":"Console HTTPS connection port number."
        },
        "ipReservations":{
            "type":"array",
            "description":"Assign automatically or choose reserved IP(s) for nodes.",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"CASSANDRA"
}

Nested Schema : ipReservations

Type: array

Assign automatically or choose reserved IP(s) for nodes.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Assign automatically or choose reserved IP(s) for nodes.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

Root Schema : accepted-response

Type: object

Show Source

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

{
    "properties":{
        "message":{
            "type":"string",
            "description":"System message that describes the operation. For example: <code>Submitted job to create service [{serviceName}] in domain [{identityDomainId}].</code>"
        },
        "jobId":{
            "type":"string",
            "description":"Job ID of the operation."
        }
    }
}