Create a Database Deployment
/paas/service/dbcs/api/v1.1/instances/{identityDomainId}
Request
- application/vnd.com.oracle.oracloud.provisioning.Service+json
-
identityDomainId: string
The value depends on the type of Exadata Cloud at Customer account that is used to make the request:
For a Traditional Cloud Account, specify the
Identity Domain Name
that is associated with the service.For a Cloud Account with Identity Cloud Service, specify the
Identity Service Id
that is associated with the service, which is a character string beginning withidcs-
.
-
Authorization: string
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: string
The value depends on the type of Exadata Cloud at Customer account that is used to make the request:
For a Traditional Cloud Account, specify the
Identity Domain Name
that is associated with the service.For a Cloud Account with Identity Cloud Service, specify the
Identity Service Id
that is associated with the service, which is a character string beginning withidcs-
.
For more information, see Security, Authentication and Authorization.
object
-
clusterName(optional):
string
Name of the cluster supporting the Exadata Cloud at Customer database deployment.
-
dbTemplate(optional):
string
The template to use for the starter database:
oltp
- configures the starter database for a transactional workload, with a bias towards high volumes of random data access.dw
- configures the starter database for a decision support or data warehouse workload, with a bias towards large data scanning operations.
Include this parameter only when creating a starter database. The starter database is the first Exadata Cloud at Customer database deployment that you create on your Exadata system. Subsequent databases are created with a standardized database configuration.
-
description(optional):
string
A description for the Exadata Cloud at Customer database deployment.
-
edition:
string
The Oracle Database software edition. For Exadata Cloud at Customer the only valid value is
EE_EP
. -
exadataSystemName(optional):
string
Name of the Exadata system on which to create the Exadata Cloud at Customer database deployment.
-
level:
string
The service level. For Exadata Cloud at Customer the only valid value is
PAAS_EXADATA
. -
nodelist(optional):
string
Specifies the list of compute nodes that host database instances for the database deployment. Separate compute node names with a comma. If
nodelist
is not specified the database is deployed across all compute nodes. -
parameters:
array parameters
Additional database configuration parameters.
-
serviceName:
string
Name for the Exadata Cloud at Customer database deployment.
Name:
Must not exceed 50 characters.
Must start with a letter.
Must contain only letters, numbers, or hyphens.
Must not end with a hyphen.
Must not contain any other special characters.
Must be unique within the identity domain.
-
standbys(optional):
array standbys
Standby database parameters. This attribute is applicable only if
failoverDatabase
is set toyes
. -
subscriptionType:
string
The billing frequency. For Exadata Cloud at Customer the only valid value is
MONTHLY
. -
version:
string
The Oracle Database software version; one of:
11.2.0.4
,12.1.0.2
or12.2.0.1
. -
vmPublicKeyText(optional):
string
The text of an SSH public key.
The key is used for authentication when connecting to Exadata Cloud at Customer using an SSH client. You generate an SSH public-private key pair using a standard SSH key generation tool. See Generating a Secure Shell (SSH) Public/Private Key Pair and Connecting to a Compute Node Through Secure Shell (SSH).
array
failoverDatabase
is set to yes
.-
Array of:
object standby-parameters
The standby database parameters.
object
-
adminPassword:
string
The administrator password for the Exadata Cloud at Customer database deployment. This password is assigned to the Oracle Database administrator users
sys
andsystem
.The password must:
Be 8 to 30 characters in length.
Contain at least one lowercase letter
Contain at least one uppercase letter
Contain at least one number
Contain at least one of these symbols: _ (underscore), # (hash sign), or - (dash or minus sign).
-
backupDestination:
string
The backup configuration for the Exadata Cloud at Customer database deployment:
OSS
- Configure backups to an Oracle Storage Cloud container.BOTH
- Configure backups to local storage on the Exadata system and to an Oracle Storage Cloud container.NONE
- Configure no backups.
-
charset(optional):
string
The Character Set for the Exadata Cloud at Customer database deployment. The 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
. -
cloudStorageContainer(optional):
string
Name of an existing Oracle Storage Cloud Service container in the format:
instance-id_domain/container
where
instance
is the name of the Oracle Storage Cloud Service instance,id_domain
is the name of the identity domain, andcontainer
is the name of the container.Do not use the Oracle Storage Cloud Service container that you are using to back up Exadata Cloud at Customer databases to cloud storage for any other purpose. For example, do not also use it to back up Oracle Java Cloud Service instances to cloud storage. Using the container for multiple purposes can result in billing errors.
-
cloudStoragePwd(optional):
string
The password of the user specified in
cloudStorageUser
. -
cloudStorageUser(optional):
string
The user name of a user who has read/write access to the container specified in
cloudStorageContainer
. -
failoverDatabase(optional):
string
Specify
yes
if an Oracle Data Guard configuration comprising a primary database and a standby database should be created. Default value isno
. -
goldenGate(optional):
string
Specify if the database is configured for use as the replication database of an Oracle GoldenGate Cloud Service instance. Valid values are
yes
andno
. The default value isno
. -
ibkup(optional):
string
Specify if the database should be instantiated using a database stored in an existing cloud backup that was created using Oracle Database Backup Cloud Service. Valid values are
yes
andno
. Default value isno
. -
ibkupCloudStorageContainer(optional):
string
Name of the Oracle Storage Cloud Service container where the existing cloud backup is stored. This parameter is required if
ibkup
is set toyes
andibkupOnPremise
is set totrue
. -
ibkupCloudStoragePassword(optional):
string
Password of the Oracle Cloud user specified in
ibkupCloudStorageUser
. This parameter is required ifibkup
is set toyes
andibkupOnPremise
is set totrue
. -
ibkupCloudStorageUser(optional):
string
User name of an Oracle Cloud user who has read access to the container specified in
ibkupCloudStorageContainer
. This parameter is required ifibkup
is set toyes
andibkupOnPremise
is set totrue
. -
ibkupDatabaseID(optional):
string
Database id of the database from which the existing cloud backup was created. This parameter is required if
ibkup
is set toyes
andibkupOnPremise
is set totrue
. -
ibkupDecryptionKey(optional):
string
Password used to create the existing, password-encrypted cloud backup. This password is used to decrypt the backup. Specify either
ibkupDecryptionKey
oribkupWalletFileContent
for decrypting the backup. A decryption key or wallet is required ifibkup
is set toyes
andibkupOnPremise
is set totrue
. -
ibkupOnPremise(optional):
boolean
Use this option to indicate the origin of the source database backup. The origin of the backup may be another Exadata Cloud at Customer database deployment in the same identity domain or another (on-premise) database that was backed up to cloud storage using Database Backup Cloud Service. Valid values are
true
for an on-premise database backup andfalse
for another Exadata Cloud at Customer database backup. Default value istrue
. -
ibkupServiceID(optional):
string
Exadata Cloud at Customer database deployment name whose backup is being used as the source of the instantiate from backup operation. This parameter is required if
ibkup
is set toyes
andibkupOnPremise
is set tofalse
. -
ibkupWalletFileContent(optional):
string
Base 64 encoded wallet file content. This wallet is used to decrypt the backup. Specify either
ibkupDecryptionKey
oribkupWalletFileContent
for decrypting the backup. A decryption key or wallet is required ifibkup
is set toyes
andibkupOnPremise
is set totrue
. -
isRac:
string
Exadata Cloud at Customer supports cluster databases only. For Exadata Cloud at Customer the only valid value is
yes
. -
ncharset(optional):
string
The National Character Set for the Exadata Cloud at Customer database deployment. The default value is
AL16UTF16
.Valid values are
AL16UTF16
andUTF8
. -
oracleHomeName(optional):
string
Name for the Oracle Home directory location that you want to use for the database deployment. If you specify the name for an existing Oracle Home directory location, then the database deployment shares the existing Oracle Database binaries at that location if
useExistingOracleHome
is also set toyes
. If you specify a new name, then a new Oracle Home is created. See Viewing Information About Oracle Homes. -
pdbName(optional):
string
The pluggable database (PDB) name for the Exadata Cloud at Customer database deployment.
This parameter is only valid for deployments using Oracle Database 12c.
Name:
Must not exceed 8 characters.
Must start with a letter.
Must contain only letters and numbers.
The default value is
pdb1
. -
sid:
string
The database system identifier (SID) name for the Exadata Cloud at Customer database deployment.
Name:
Must not exceed 8 characters.
Must start with a letter.
Must contain only letters and numbers.
The default value is
ORCL
. -
snapshotName(optional):
string
Name of the existing snapshot master being used as the source for the new snapshot clone. This parameter is valid only if
sourceServiceName
is specified, and should be set to the same value as that supplied forsourceServiceName
. -
sourceServiceName(optional):
string
When present, indicates that the database deployment should be created as a snapshot clone. Provide the name of the existing snapshot master being used as the source for the new snapshot clone.
-
type:
string
The component type to which the set of parameters applies. For Exadata Cloud at Customer the only valid value is
db
. -
useExistingOracleHome(optional):
string
This parameter is required with a value of
yes
if you want to create a database deployment in an existing Oracle Home directory location. Default value isno
.
object
-
clusterName(optional):
string
Name of the cluster on which to create the standby database for a database deployment that uses Oracle Data Guard.
-
exadataSystemName(optional):
string
Name of the Exadata system on which to create the standby database for a database deployment that uses Oracle Data Guard.
-
nodelist(optional):
string
Specifies the list of compute nodes that host database instances for the standby database. Separate compute node names with a comma. If
nodelist
is not specified the database is deployed across all compute nodes.
Response
202 Response
The Location header returns a REST URI that can be used to access the status of the operation, as described in View the Status of an Operation.
Examples
The following example shows how to create an Exadata Cloud at Customer database deployment 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 serviceadmin
and Pa55_word
. The request body specifies the creation of an instance named db12c
on an Exadata system named exasys
.
cURL Command
In the following cURL command, the request body is provided in the -d
option by using the @
notation to refer to the contents of the createrequestbody.json
file on the local machine.
curl -i -X POST --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample" -H "Content-Type:application/json" -d @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.
{ "serviceName": "db12c", "description": "Example Exadata Cloud at Customer database deployment created using REST API", "edition": "EE_EP", "exadataSystemName": "exasys", "clusterName": "cluster1", "level": "PAAS_EXADATA", "subscriptionType": "MONTHLY", "version": "12.2.0.1", "vmPublicKeyText": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEA7QMRmWQuy09cQdrJd7h0VoWDIpNRmdRUHaCenu3RRRt2IGasAhLw7DI1yP9JXyJ9c2dKkteQXIB3FRYCAWj7T/r4yPLbzrMEpcuANdBRhkQvwyqDEbNWsqoQoxRBRDTcYEObiJ4PvcH7bV1MR++OtqDg2qBT2f+KwVglH8MuyB7yg/DGuP1j1Lwylwzy/Iw+TzLaWP0l3woZGL7KIZWkkXKUx+nvqY8iEb/4/YqN9ZK4GGK7vLCrrICK3RTjDhclHg1s+64Bb0IqceZpY38xAI8EW/4PNyv3Ag7IZEkiojOEd3znYexsZK3b78+VKWewOsffXqnVHrANAGzedLz/ew== rsa-key-20160712", "parameters": [ { "adminPassword": "Pa55_word", "backupDestination": "OSS", "cloudStorageContainer": "Storage-usexample/ExaCSbackups", "cloudStorageUser": "serviceadmin", "cloudStoragePwd": "Pa55_word", "isRac": "yes", "pdbName": "DB12CP1", "sid": "DB12C", "type": "db" } ] }
HTTP Status Code and Response Headers
HTTP/2.0 202 server: Oracle-Application-Server-11g strict-transport-security: max-age=31536000;includeSubDomains location: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/status/create/job/12209047 content-language: en access-control-allow-origin: * access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME retry-after: 60 access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD x-oracle-dms-ecid: 005K9zY1FEA6uHFpR05Eid0007dd00024l x-oracle-dms-ecid: 005K9zY1FEA6uHFpR05Eid0007dd00024l service-uri: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/db12c x-frame-options: DENY content-type: application/json vary: user-agent date: Mon, 29 May 2017 01:48:26 GMT