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

Create a Service Instance

post

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}

Creates a Database Classic Cloud Service instance.

Using this endpoint you can create a Database Classic Cloud Service instance hosting one of the following types of database:

  • A single-instance database

  • Two single-instance databases, one acting as the primary database and one acting as the standby database in an Oracle Data Guard configuration

  • A two-node clustered database using Oracle Real Application Clusters (RAC) technology; two compute nodes each host an Oracle Database instance, and the two instances access the same shared database data store

  • Two two-node Oracle RAC databases, one acting as the primary database and one acting as the standby database in an Oracle Data Guard configuration

  • A single-instance database acting as the standby database in an Oracle Data Guard configuration. The primary database is on your own system

Additionally, if you create a single-instance database, you can create it as a "snapshot clone" of another service instance or have its database loaded from the cloud backup of another database (often called "instantiate from backup").

Request

Supported Media Types
Path Parameters
  • Identity domain ID for the Database Classic Cloud Service account:
     

    • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

    • For a traditional cloud account: the name of the identity domain.

Header Parameters
  • Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
  • Identity domain ID for the Database Classic Cloud Service account:
     

    • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

    • For a traditional cloud account: the name of the identity domain.

Body ()
Root Schema : Request Body
Type: object
Title: Request Body
Show Source
  • Applicable only if region is an Oracle Cloud Infrastructure Classic region and an ipNetwork value is provided.

    Specify whether to assign public IP addresses to the compute nodes of the service instance:

    • When set to true, any compute node added during instance creation, or later added as part of a scaling operation, will have a public IP address assigned to it. Thus, all compute nodes will be accessible from the public Internet, provided that access rules permitting such access are enabled.

    • When set to false, any compute node added during instance creation, or later added as part of a scaling operation, will not have a public IP address assigned to it. Thus, no compute node will be accessible from the public Internet. Use this value in situations where the nodes and the database will only be accessed from within the IP network or from an on-premises data center over a VPN network.

    Default value is true.

  • Required if region is an Oracle Cloud Infrastructure region.

    Name of the availability domain within the region where the Oracle Database Classic Cloud Service instance is to be provisioned.

  • Free-form text that provides additional information about the service instance.

  • Database edition for the service instance:

    • SE: Standard Edition

    • EE: Enterprise Edition

    • EE_HP: Enterprise Edition - High Performance

    • EE_EP: Enterprise Edition - Extreme Performance

    If you specify SE, a Standard Edition 2 database is created if you specify 12.2.0.1 or 12.1.0.2 for version and a Standard Edition One database is created if you specify 11.2.0.4 for version.

    Edition must be Enterprise Edition - Extreme Performance to configure the Database Classic Cloud Service instance as Cluster Database.

  • Specify if you want an email notification sent upon successful or unsuccessful completion of the instance-creation operation. When true, you must also specify notificationEmail. Valid values are true and false. Default value is false.

    This parameter is not available on Oracle Cloud at Customer.

  • Applicable only if region is an Oracle Cloud Infrastructure Classic region.

    The three-part name of a custom IP network to use. For example: /Compute-identity_domain/user/object.

    A region must be specified in order to use ipNetwork. Only IP networks created in the specified region can be used.

    You cannot use ipNetwork when creating a service instance that uses Oracle RAC and Oracle Data Guard to provide for disaster recovery. That is, when isRac, failoverDatabase and disasterRecovery are all set to "yes" in the parameters array element.

  • Applicable only if region is an Oracle Cloud Infrastructure Classic region.

    A single IP reservation name or multiple IP reservation names separated by commas. Only IP reservations created in the specified region can be used.

    When IP reservations are used, all compute nodes of an instance must be provisioned with IP reservations, so the number of names in ipReservations must match the number of compute nodes in the service instance.

  • Specify if you want to use an existing perpetual license to Oracle Database to establish the right to use Oracle Database on the new instance. When true, your Oracle Cloud account will be charged a lesser amount for the new instance because the right to use Oracle Database is covered by your perpetual license agreement. Valid values are true and false. Default value is false.
  • Service level for the service instance. Specify the value PAAS.

    Note: Some older accounts also support the value BASIC to denote the "Oracle Database Classic Cloud Service - Virtual Image" service level.

  • Required if enableNotification is set to true.

    The email address to send completion notifications to.

    This parameter is not available on Oracle Cloud at Customer.

  • parameters Array
    Title: parameters Array
    Array of one JSON object that specifies configuration details of the services instance. This array is not required if the level value is BASIC.
  • Applicable only to accounts that support regions.

    Name of the Oracle Cloud Infrastructure or Oracle Cloud Infrastructure Classic region where the Oracle Database Classic Cloud Service instance is to be provisioned.

    Note: When specifying an Oracle Cloud Infrastructure region, the region must be in the default data region of the Cloud account.

  • Name of Database Classic Cloud Service instance. The service name:
    • Must not exceed 50 characters.
    • Must start with a letter.
    • Must contain only letters, numbers, or hyphens.
    • Must not contain any other special characters.
    • Must be unique within the identity domain.
  • Desired compute shape. A shape defines a number of Oracle Compute Units (OCPUs) and an amount of processor RAM. The valid shapes you can choose from depend on which infrastructure you are using for the instance:
     

    • For instances on Oracle Cloud Infrastructure:

      View a list of currently available shapes by going to the Pricing page for Oracle Cloud Infrastructure Compute on cloud.oracle.com. The "BM.Standard" shapes in the Compute - Bare Metal Instances table and the "VM.Standard" shapes in the Compute - Virtual Machine Instances table are available in Oracle Database Classic Cloud Service.

    • For instances on Oracle Cloud Infrastructure Classic:

      View a list of currently available shapes by going to the Pricing page for Oracle Cloud Infrastructure Compute Classic - General Purpose Compute on cloud.oracle.com. The shapes in the General Purpose Shapes and the High Memory Shapes tables are available in Oracle Database Classic Cloud Service.

    Note: Not all shapes are available in all regions or sites.

  • standbys Array
    Title: standbys Array
    Applicable only in Oracle Cloud Infrastructure regions.

    Array of one JSON object that specifies configuration details of the standby database when failoverDatabase is set to true. disasterRecovery must be set to true.

  • Required if region is an Oracle Cloud Infrastructure region.

    The Oracle Cloud Identifier (OCID) of the subnet in the virtual cloud network (VCN) within the region where the Oracle Database Classic Cloud Service instance is to be provisioned.

    The OCID is a unique autogenerated ID. To find 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.

  • Billing unit. Specify the value HOURLY or MONTHLY.

    Note: The MONTHLY value is not available in accounts that use the Universal Credits payment model.

  • Applicable only in Oracle Cloud Infrastructure Classic regions.

    Specify if high performance storage should be used for the Database Classic Cloud Service instance. Default data storage will allocate your database block storage on spinning devices. By checking this box, your block storage will be allocated on solid state devices. Valid values are true and false. Default value is false.

  • Oracle Database software version; one of: 18.0.0.0, 12.2.0.1, 12.1.0.2, or 11.2.0.4.
  • Public key for the secure shell (SSH). This key will be used for authentication when connecting to the Database Classic Cloud Service instance using an SSH client. You generate an SSH public-private key pair using a standard SSH key generation tool. See Connecting to a Compute Node Through Secure Shell (SSH) in Using Oracle Database Classic Cloud Service.
Nested Schema : parameters Array
Type: array
Title: parameters Array
Array of one JSON object that specifies configuration details of the services instance. This array is not required if the level value is BASIC.
Show Source
Nested Schema : standbys Array
Type: array
Title: standbys Array
Applicable only in Oracle Cloud Infrastructure regions.

Array of one JSON object that specifies configuration details of the standby database when failoverDatabase is set to true. disasterRecovery must be set to true.

Show Source
Nested Schema : parameters Array Item
Type: object
Title: parameters Array Item
Show Source
  • additionalParams Object
    Title: additionalParams Object

  • The password for the following administrative users:

    • Oracle Database administrative users sys and system
    • Oracle Application Express admin user
    • DBaaS Monitor user

    The password:

    • Must be 8 to 30 characters in length.
    • Must contain at least one lowercase letter.
    • Must contain at least one uppercase letter.
    • Must contain at least one number.
    • Must contain at least one of these symbols: _ (underscore), # (hash sign), or $ (dollar sign).
    • Must not contain the word "oracle".
  • Backup destination. Valid values are:
    • BOTH - Both Cloud Storage and Local Storage
    • OSS - Cloud Storage only
    • NONE - None
  • Character Set for the Database Classic Cloud Service Instance. Default value is AL32UTF8.

    Valid values are AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS.

  • The location where backups to cloud storage are to be stored:

    • For service instances in Oracle Cloud Infrastructure, enter the URL of an existing Oracle Cloud Infrastructure Object Storage bucket. The URL is of the form:

      https://swiftobjectstorage.region.oraclecloud.com/v1/account/bucket

      For example:

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

      You must create this storage bucket before you begin creating the service instace. See Object Storage API in Oracle Cloud Infrastructure documentation.

    • For database deployments in Oracle Cloud Infrastructure Classic, enter the location of an Oracle Cloud Infrastructure Object Storage Classic container using this form:

      Storage-identity_domain/container

      where identity_domain is the id of the identity domain, and container is the name of the container.

      Note: In some Oracle Cloud Infrastructure Classic accounts, you cannot use the above form. If you get an error when you try to use this form, you must instead provide a full URL for the container using this form:

      rest-endpoint-url/container

      To determine the rest-endpoint-url value for your account, see About REST URLs for Oracle Cloud Infrastructure Object Storage Classic Resources in Using Oracle Cloud Infrastructure Object Storage Classic.

  • The password necessary to access the location specified in cloudStorageContainer:

    • For service instances in Oracle Cloud Infrastructure, enter your Swift password.

    • For service instances in Oracle Cloud Infrastructure Classic, enter the password of the Oracle Cloud user specified in cloudStorageUser.

  • A user with read/write (and creation, if necessary) access to the location specified in cloudStorageContainer:

    • For service instances in Oracle Cloud Infrastructure, enter the user name you use to sign in to the Oracle Cloud Infrastructure console.

    • For service instances in Oracle Cloud Infrastructure Classic, enter the Oracle Cloud user name of the administrator of the Oracle Cloud Infrastructure Object Storage Classic container specified in cloudStorageContainer. Usually, this is your Oracle Cloud user name.

  • Applicable only to Oracle Cloud Infrastructure Object Storage Classic containers.

    Specify if the given cloudStorageContainer is to be created if it does not already exist. Valid values are true and false. Default value is false.

  • Specify if an Oracle Data Guard configuration is created using the Disaster Recovery option or the High Availability option. Valid values are yes and no:

    • yes - The Disaster Recovery option is used, which places the compute node hosting the primary database and the compute node hosting the standby database in compute zones of different data centers.

    • no - The High Availability option is used, which places the compute node hosting the primary database and the compute node hosting the standby database in different compute zones of the same data center.

    Default value is no.

    This option is applicable only when failoverDatabase is set to yes.

  • Specify if an Oracle Data Guard configuration comprising a primary database and a standby database is created. Valid values are yes and no. Default value is no.
  • Specify if the database should be configured for use as the replication database of an Oracle GoldenGate Cloud Service instance. Valid values are yes and no. Default value is no.

    You cannot set goldenGate to yes if either isRac or failoverDatabase is set to yes.

  • Specify if an Oracle Hybrid Disaster Recovery configuration comprising a primary database on customer premisesand a standby database in Oracle Public Cloud should be configured. Valid values are yes and no. Default value is no.

    You cannot set failoverDatabase or isRac to yes if Hybrid Disaster Recovery options is chosen.

  • Name of the Oracle Storage Cloud Service container where the backup from on-premise instance is stored. This parameter is required if hdg is set to yes.
  • Password of the Oracle Cloud user specified in hdgCloudStorageUser. This parameter is required if hdg is set to yes.
  • User name of an Oracle Cloud user who has read access to the container specified in hdgCloudStorageContainer. This parameter is required if hdg is set to yes.
  • Specify if the service instance's database should, after the instance is created, be replaced by a database stored in an existing cloud backup that was created using Oracle Database Backup Cloud Service. Valid values are yes and no. Default value is no.
  • Backup tag of the specific backup from which the database of new Oracle Database Classic Cloud Service instance should be created. This parameter is valid only if ibkup is set to yes and ibkupOnPremise is set to no. If no value is specified, the latest backup is used.
  • Name of the Oracle Storage Cloud Service container where the existing cloud backup is stored. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to yes.
  • Password of the Oracle Cloud user specified in ibkupCloudStorageUser. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to yes.
  • User name of an Oracle Cloud user who has read access to the container specified in ibkupCloudStorageContainer. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to yes.
  • Database id of the database from which the existing cloud backup was created. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to yes.
  • Password used to create the existing, password-encrypted cloud backup. This password is used to decrypt the backup. Specify either ibkupDecryptionKey or ibkupWalletFileContent for decrypting the backup. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to yes.
  • Specify if the existing cloud backup being used to replace the database is from an on-premises database or another Database Classic Cloud Service instance. Valid values are true for an on-premises database and false for a Database Classic Cloud Service instance. Default value is true.
  • Oracle Databsae Cloud Service instance name from which the database of new Oracle Database Classic Cloud Service instance should be created. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to no.
  • String containing the xsd:base64Binary representation of the cloud backup's wallet file. This wallet is used to decrypt the backup. Specify either ibkupDecryptionKey or ibkupWalletFileContent for decrypting the backup. This parameter is required if ibkup is set to yes and ibkupOnPremise is set to yes.
  • Specify if a cluster database using Oracle Real Application Clusters should be configured. Valid values are yes and no. Default value is no.
  • The port number for the Oracle Net Listener. The port number must be between 1521 and 5499 (inclusive). Default value is 1521.
  • National Character Set for the Database Classic Cloud Service instance. Default value is AL16UTF16.

    Valid values are AL16UTF16 and UTF8.

  • Note: This attribute is valid when Database Classic Cloud Service instance is configured with version 12c.

    Pluggable Database Name for the Database Classic Cloud Service instance. Default value is pdb1.

  • Database Name (sid) for the Database Classic Cloud Service instance. Default value is ORCL.
  • The name of the snapshot of the service instance specified by sourceServiceName that is to be used to create a "snapshot clone". This parameter is valid only if sourceServiceName is specified.
  • When present, indicates that the service instance should be created as a "snapshot clone" of another service instance. Provide the name of the existing service instance whose snapshot is to be used.
  • Time Zone for the Database Classic Cloud Service instance. Default value is UTC.

    Valid values are Africa/Cairo, Africa/Casablanca, Africa/Harare, Africa/Monrovia, Africa/Nairobi, Africa/Tripoli, Africa/Windhoek, America/Araguaina, America/Asuncion, America/Bogota, America/Caracas, America/Chihuahua, America/Cuiaba, America/Denver, America/Fortaleza, America/Guatemala, America/Halifax, America/Manaus, America/Matamoros, America/Monterrey, America/Montevideo, America/Phoenix, America/Santiago, America/Tijuana, Asia/Amman, Asia/Ashgabat, Asia/Baghdad, Asia/Baku, Asia/Bangkok, Asia/Beirut, Asia/Calcutta, Asia/Damascus, Asia/Dhaka, Asia/Irkutsk, Asia/Jerusalem, Asia/Kabul, Asia/Karachi, Asia/Kathmandu, Asia/Krasnoyarsk, Asia/Magadan, Asia/Muscat, Asia/Novosibirsk, Asia/Riyadh, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Taipei, Asia/Tehran, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Vladivostok, Asia/Yakutsk, Asia/Yerevan, Atlantic/Azores, Australia/Adelaide, Australia/Brisbane, Australia/Darwin, Australia/Hobart, Australia/Perth, Australia/Sydney, Brazil/East, Canada/Newfoundland, Canada/Saskatchewan, Europe/Amsterdam, Europe/Athens, Europe/Dublin, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/Moscow, Europe/Paris, Europe/Prague, Europe/Sarajevo, Pacific/Auckland, Pacific/Fiji, Pacific/Guam, Pacific/Honolulu, Pacific/Samoa, US/Alaska, US/Central, US/Eastern, US/East-Indiana, US/Pacific, UTC.

  • Component type to which the set of parameters applies. Valid values are:
    • db - Oracle Database
      • .
  • Storage size for data (in GB). Minimum value is 15. Maximum value depends on the backup destination: if BOTH is specified, the maximum value is 1200; if OSS or NONE is specified, the maximum value is 2048.
Nested Schema : additionalParams Object
Type: object
Title: additionalParams Object
Show Source
Nested Schema : standbys Array Item
Type: object
Title: standbys Array Item
Show Source
  • Applicable only in Oracle Cloud Infrastructure regions.

    Name of the availability domain within the region where the standby database of the Oracle Database Classic Cloud Service instance is to be provisioned.

  • Applicable only in Oracle Cloud Infrastructure regions.

    Name of the subnet within the region where the standby database of the Oracle Database Classic Cloud Service instance is to be provisioned.

Back to Top

Response

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.
Headers
  • A REST URI you can use to check the progress and completion of the instance creation operation.
Back to Top

Examples

The following example shows how to create a Database Classic Cloud Service instance by submitting a POST request on the REST endpoint using cURL.

This example uses a traditional cloud account, so the {identityDomainId} path parameter and the X-ID-TENANT-NAME header parameter are set to the account's domain name, which is usexample. The Oracle Cloud user name of the user making the call is dbcsadmin. The request body specifies the creation of a service instance named db12c-xp-si.

cURL Command

In the following cURL command, the request body is provided in the --data option by using the @ notation to refer to the contents of the createrequestbody.json file on the local machine. 

curl --include --request POST \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
--header "Content-Type:application/json" \
--data @createrequestbody.json \
https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample

Request Body

Here is a listing of the request body, which is contained in the createrequestbody.json file. 

{
  "description": "Example service instance",
  "edition": "EE_HP",
  "level": "PAAS",
  "serviceName": "db12c-xp-si",
  "shape": "oc3",
  "subscriptionType": "MONTHLY",
  "version": "12.1.0.2",
  "vmPublicKeyText": "public-key-value",
  "parameters": [
    {
      "type": "db",
      "usableStorage": "15",
      "adminPassword": "Welcome_1",
      "sid": "ORCL",
      "pdbName": "MYPDB",
      "failoverDatabase": "no",
      "backupDestination": "BOTH",
      "cloudStorageContainer": "Storage-usexample\/dbcsbackups",
      "cloudStorageUser": "dbcsadmin",
      "cloudStoragePwd": "password"
    }
  ]
}

HTTP Status Code and Response Headers

HTTP/1.1 202 Accepted
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Location: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/status/create/job/5770753
Content-Length: 0
X-ORACLE-DMS-ECID: id-string
X-ORACLE-DMS-ECID: id-string
X-Frame-Options: DENY
Service-URI: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/db12c-xp-si
Vary: Accept-Encoding,User-Agent
Retry-After: 60
Content-Language: en
Content-Type: application/json
Back to Top