Create a Service Instance

post

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

Creates a Database Cloud Service instance.

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

  • A single-instance database running Oracle Database Release 12.2, 12.1 or 11.2

  • A two-node clustered database using Oracle Real Application Clusters (RAC) running Oracle Database Release 12.1 or 11.2

  • An Oracle Data Guard configuration comprising a primary database and a standby database, both running Oracle Database Release 12.2, 12.1 or 11.2

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
  • application/vnd.com.oracle.oracloud.provisioning.Service+json
Path Parameters
identityDomainId
Type: string
Required: true
Name of the identity domain for the Database Cloud Service account.
Header Parameters
Authorization
Type: string
Required: true
Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
X-ID-TENANT-NAME
Type: string
Required: true
Name of the identity domain for the Database Cloud Service account. For more information, see Security, Authentication and Authorization.
Body Parameter
Root Schema : Request Body
Type: object
Title: Request Body
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.
Nested Schema : parameters Array Item
Type: object
Title: parameters Array Item
Nested Schema : additionalParams Object
Type: object
Title: additionalParams Object

Response

202 Response
Accepted. See Status Codes for information about other possible HTTP status codes.
Headers
Location
Type: string
A REST URI you can use to check the progress and completion of the instance creation operation.

Examples

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

In this example, the identity domain is usexample and the Oracle Cloud user name and password are dbaasadmin and Pa55_word. 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 dbaasadmin:Pa55_word \
--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": "ssh-rsa AAAAB3NzaC1y...",
  "parameters": [
    {
      "type": "db",
      "usableStorage": "15",
      "adminPassword": "Welcome_1",
      "sid": "ORCL",
      "pdbName": "MYPDB",
      "failoverDatabase": "no",
      "backupDestination": "BOTH",
      "cloudStorageContainer": "Storage-usexample\/dbcsbackups",
      "cloudStorageUser": "dbaasadmin",
      "cloudStoragePwd": "Pa55_word"
    }
  ]
}

HTTP Status Code and Response Headers

HTTP/1.1 202 Accepted
Date: Mon, 18 Jul 2016 19:22:45 GMT
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: 005Dyr^aRQS6uHFpR05Eid0006B_00054J
X-ORACLE-DMS-ECID: 005Dyr^aRQS6uHFpR05Eid0006B_00054J
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