Previous Next JavaScript must be enabled to correctly display this content

## Create database

post

/databases

Create new database in Oracle Database Appliance using DBRequest parameters. Ensure that the repository is updated with Oracle RDBMS Clone files for the database version, before creating the database.

### Request

Supported Media Types

- application/json

Header Parameters

- opc-idempotency-token: string
  Minimum Length: `1`
  Maximum Length: `64`
  A user-supplied token that uniquely identifies a request. A single request will be acted upon among many requests that share the same token. Idempotency tokens expire after 30 minutes.

Body ()
database creation parameters
Root Schema : DBRequest
Type: `object`
Show Source

- adminPassword: string
- associatedNetworkNames: array associatedNetworkNames
  names of associated networks
- associatedNetworks: array associatedNetworks
  ids of associated networks
- backupConfigId: string
- backupConfigName: string
- cpuPool: string
  Defines the CPU Pool name
- databaseUniqueName: string
- dbCharacterSet: object DbCharacterSet
- dbClass: string
  Allowed Values: `[ "OLTP", "DSS", "IMDB" ]`
- dbConsoleEnable: boolean
- dbDomainName: string
- dbEdition: string
  Database Home Edition(EE/SE).
- dbHomeId: string
  The database home resource identifier for associating this database to.
- dbName(required): string
- dbOnFlashStorage: boolean
  Option to select FLASH for storing database data files
- dbRedundancy: string
- dbRole: string
  Database role (PRIMARY/STANDBY).
- dbShape: string
  Allowed Values: `[ "odb1s", "odb1", "odb2", "odb4", "odb6", "odb8", "odb10", "odb12", "odb16", "odb20", "odb24", "odb28", "odb32", "odb36", "odb42", "odb48", "odb56", "odb64" ]`
- dbStorage: string
  Allowed Values: `[ "ASM", "ACFS", "PMEM" ]`
- dbTargetNodeName: string
  Target node where the database runs on. Applies to EE dbType.
- dbType: string
  Allowed Values: `[ "RAC", "RACOne", "SI" ]`
- dbVersion: string
- enableEEHA: boolean
  Enable HA for EE SI database
- enableFlashCache: boolean
  Option to enable FLASH CACHE
- enableSEHA: boolean
  Enable HA for SE for 19c and later SI database
- enableTDE: boolean
  Transparent Data Encryption (TDE) feature in the database being created. By default, TDE will not be configured.
- instanceOnly: boolean
  do not create the database files. Used in case of standby case to create standby instance.
- isCdb: boolean
- isFileConversionComplete: boolean
  Flag to check if the permissions and ownership of db files have been modified
- keystoreType: string
  Type of keystore, which stores TDE Master Encryption Key. Either Software or OKV. Default is Software
- level0BackupDay: string
  Allowed Values: `[ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ]`
- okvClientPath: string
  Absolute path to okvclient.jar file. Multiple values must be comma separated.
- okvServerConfigName: string
  Name of the OKV Server Config object which represents the metadata of OKV server where TDE Master Encryption Keys are stored
- pdbAdminuserName: string
- pdBName: string
- pdbSourceType: string
  Allowed Values: `[ "SEED", "PDB", "ARCHIVE" ]`
  The source type to create the PDB
- quota: string
  disk space quota for a database.
- registerOnly: boolean
  Use to migrate existing database
- rmanBkupPassword: string
- sourcePdbArchivePath: string
  The absolute file name of the PDB archive file if ARCHIVE used in sourceType
- sourcePdbName: string
  The source PDB name if PDB is used in pdbSource
- sourceTDEPassword: string
  TDE password of source PDB.
- tdePassword: string
  Password used for password protected software keystore.
- unifiedAuditing: string
  Enable unified auditing for the database or not (TRUE/FALSE).

    {
        "required":[
            "dbName"
        ],
        "properties":{
            "dbName":{
                "type":"string"
            },
            "databaseUniqueName":{
                "type":"string"
            },
            "dbVersion":{
                "type":"string"
            },
            "dbHomeId":{
                "description":"The database home resource identifier for associating this database to.",
                "type":"string"
            },
            "instanceOnly":{
                "description":"do not create the database files. Used in case of standby case to create standby instance.",
                "type":"boolean"
            },
            "registerOnly":{
                "description":"Use to migrate existing database",
                "type":"boolean"
            },
            "isCdb":{
                "type":"boolean"
            },
            "pdBName":{
                "type":"string"
            },
            "pdbAdminuserName":{
                "type":"string"
            },
            "pdbSourceType":{
                "description":"The source type to create the PDB",
                "type":"string",
                "enum":[
                    "SEED",
                    "PDB",
                    "ARCHIVE"
                ]
            },
            "sourcePdbName":{
                "description":"The source PDB name if PDB is used in pdbSource",
                "type":"string"
            },
            "sourcePdbArchivePath":{
                "description":"The absolute file name of the PDB archive file if ARCHIVE used in sourceType",
                "type":"string"
            },
            "enableTDE":{
                "description":"Transparent Data Encryption (TDE) feature in the database being created. By default, TDE will not be configured.",
                "type":"boolean"
            },
            "okvClientPath":{
                "description":"Absolute path to okvclient.jar file. Multiple values must be comma separated.",
                "type":"string"
            },
            "tdePassword":{
                "description":"Password used for password protected software keystore.",
                "type":"string"
            },
            "sourceTDEPassword":{
                "description":"TDE password of source PDB.",
                "type":"string"
            },
            "adminPassword":{
                "type":"string"
            },
            "dbType":{
                "type":"string",
                "enum":[
                    "RAC",
                    "RACOne",
                    "SI"
                ]
            },
            "dbRole":{
                "description":"Database role (PRIMARY/STANDBY).",
                "type":"string"
            },
            "dbClass":{
                "type":"string",
                "enum":[
                    "OLTP",
                    "DSS",
                    "IMDB"
                ]
            },
            "dbShape":{
                "type":"string",
                "enum":[
                    "odb1s",
                    "odb1",
                    "odb2",
                    "odb4",
                    "odb6",
                    "odb8",
                    "odb10",
                    "odb12",
                    "odb16",
                    "odb20",
                    "odb24",
                    "odb28",
                    "odb32",
                    "odb36",
                    "odb42",
                    "odb48",
                    "odb56",
                    "odb64"
                ]
            },
            "dbStorage":{
                "type":"string",
                "enum":[
                    "ASM",
                    "ACFS",
                    "PMEM"
                ]
            },
            "dbRedundancy":{
                "type":"string"
            },
            "quota":{
                "type":"string",
                "description":"disk space quota for a database."
            },
            "dbCharacterSet":{
                "$ref":"#/definitions/DbCharacterSet"
            },
            "dbConsoleEnable":{
                "type":"boolean"
            },
            "backupConfigId":{
                "type":"string"
            },
            "backupConfigName":{
                "type":"string"
            },
            "dbOnFlashStorage":{
                "description":"Option to select FLASH for storing database data files",
                "type":"boolean"
            },
            "dbEdition":{
                "description":"Database Home Edition(EE/SE).",
                "type":"string"
            },
            "rmanBkupPassword":{
                "type":"string"
            },
            "dbDomainName":{
                "type":"string"
            },
            "enableFlashCache":{
                "description":"Option to enable FLASH CACHE",
                "type":"boolean"
            },
            "level0BackupDay":{
                "type":"string",
                "enum":[
                    "monday",
                    "tuesday",
                    "wednesday",
                    "thursday",
                    "friday",
                    "saturday",
                    "sunday"
                ]
            },
            "associatedNetworks":{
                "description":"ids of associated networks",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "associatedNetworkNames":{
                "description":"names of associated networks",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "unifiedAuditing":{
                "description":"Enable unified auditing for the database or not (TRUE/FALSE).",
                "type":"string"
            },
            "enableSEHA":{
                "description":"Enable HA for SE for 19c and later SI database",
                "type":"boolean"
            },
            "enableEEHA":{
                "description":"Enable HA for EE SI database",
                "type":"boolean"
            },
            "dbTargetNodeName":{
                "description":"Target node where the database runs on. Applies to EE dbType.",
                "type":"string"
            },
            "cpuPool":{
                "description":"Defines the CPU Pool name",
                "type":"string"
            },
            "isFileConversionComplete":{
                "description":"Flag to check if the permissions and ownership of db files have been modified",
                "type":"boolean"
            },
            "keystoreType":{
                "description":"Type of keystore, which stores TDE Master Encryption Key. Either Software or OKV. Default is Software",
                "type":"string"
            },
            "okvServerConfigName":{
                "description":"Name of the OKV Server Config object which represents the metadata of OKV server where TDE Master Encryption Keys are stored",
                "type":"string"
            }
        }
    }

Nested Schema : associatedNetworkNames
Type: `array`
names of associated networks
Show Source

- Array of: string

    {
        "description":"names of associated networks",
        "type":"array",
        "items":{
            "type":"string"
        }
    }

Nested Schema : associatedNetworks
Type: `array`
ids of associated networks
Show Source

- Array of: string

    {
        "description":"ids of associated networks",
        "type":"array",
        "items":{
            "type":"string"
        }
    }

Nested Schema : DbCharacterSet
Type: `object`
Show Source

- characterSet: string
- dbLanguage: string
- dbTerritory: string
- nlsCharacterset: string

    {
        "properties":{
            "characterSet":{
                "type":"string"
            },
            "nlsCharacterset":{
                "type":"string"
            },
            "dbTerritory":{
                "type":"string"
            },
            "dbLanguage":{
                "type":"string"
            }
        }
    }

Back to Top

### Response

Supported Media Types

- application/json

#### 200 Response

database deployment state using name filter.
Body ()
Root Schema : ServiceJobReport
Type: `object`
Job Request Status
Show Source

- cpsMetadata: string
- createTimestamp: string(date-time)
- description: string
- jobId: string
- jobType: string
- message: string
- reports: array reports
- resourceList: array resourceList
- status: string
  Allowed Values: `[ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "RunningTaskOnFail" ]`
- updatedTime: string(date-time)

    {
        "description":"Job Request Status",
        "properties":{
            "jobId":{
                "type":"string"
            },
            "status":{
                "type":"string",
                "enum":[
                    "Created",
                    "Scheduled",
                    "Running",
                    "Success",
                    "Failure",
                    "Retrying",
                    "Waiting",
                    "InternalError",
                    "Reverting",
                    "Reverted",
                    "NodeDisconnectedFailure",
                    "RunningTaskOnFail"
                ]
            },
            "message":{
                "type":"string"
            },
            "reports":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/TaskReport"
                }
            },
            "createTimestamp":{
                "type":"string",
                "format":"date-time"
            },
            "resourceList":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/JobResourceInfo"
                }
            },
            "description":{
                "type":"string"
            },
            "updatedTime":{
                "type":"string",
                "format":"date-time"
            },
            "jobType":{
                "type":"string"
            },
            "cpsMetadata":{
                "type":"string"
            }
        }
    }

Nested Schema : reports
Type: `array`
Show Source

- Array of: object TaskReport

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/TaskReport"
        }
    }

Nested Schema : resourceList
Type: `array`
Show Source

- Array of: object JobResourceInfo
  resource information

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/JobResourceInfo"
        }
    }

Nested Schema : TaskReport
Type: `object`
Show Source

- duration: string
- endTime: string(date-time)
- jobId: string
- nodeName: string
- parentTaskId: string
- reportLevel: string
  Allowed Values: `[ "Verbose", "Info", "Error" ]`
- startTime: string(date-time)
- status: string
  Allowed Values: `[ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "Skipped" ]`
- tags: array tags
- taskDescription: string
- taskId: string
- taskName: string
- taskResult: string
- updatedTime: string(date-time)

    {
        "properties":{
            "taskId":{
                "type":"string"
            },
            "taskName":{
                "type":"string"
            },
            "nodeName":{
                "type":"string"
            },
            "taskResult":{
                "type":"string"
            },
            "startTime":{
                "type":"string",
                "format":"date-time"
            },
            "endTime":{
                "type":"string",
                "format":"date-time"
            },
            "duration":{
                "type":"string"
            },
            "status":{
                "type":"string",
                "enum":[
                    "Created",
                    "Scheduled",
                    "Running",
                    "Success",
                    "Failure",
                    "Retrying",
                    "Waiting",
                    "InternalError",
                    "Reverting",
                    "Reverted",
                    "NodeDisconnectedFailure",
                    "Skipped"
                ]
            },
            "taskDescription":{
                "type":"string"
            },
            "parentTaskId":{
                "type":"string"
            },
            "jobId":{
                "type":"string"
            },
            "tags":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "reportLevel":{
                "type":"string",
                "enum":[
                    "Verbose",
                    "Info",
                    "Error"
                ]
            },
            "updatedTime":{
                "type":"string",
                "format":"date-time"
            }
        }
    }

Nested Schema : tags
Type: `array`
Show Source

- Array of: string

    {
        "type":"array",
        "items":{
            "type":"string"
        }
    }

Nested Schema : JobResourceInfo
Type: `object`
resource information
Show Source

- jobId: string
- resourceId: string
- resourceNewType: string
- resourceType: string
  Allowed Values: `[ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Pdb", "Recovery", "Report", "Tde", "ObjectStoreSwift" ]`
- updatedTime: string(date-time)

    {
        "description":"resource information",
        "properties":{
            "resourceId":{
                "type":"string"
            },
            "resourceType":{
                "type":"string",
                "enum":[
                    "Backup",
                    "BackupConfig",
                    "DB",
                    "DbHome",
                    "Grid",
                    "Pdb",
                    "Recovery",
                    "Report",
                    "Tde",
                    "ObjectStoreSwift"
                ]
            },
            "resourceNewType":{
                "type":"string"
            },
            "jobId":{
                "type":"string"
            },
            "updatedTime":{
                "type":"string",
                "format":"date-time"
            }
        }
    }

#### Default Response

An unexpected error has occurred
Body ()
Root Schema : Error
Type: `object`
Show Source

- code(required): string
- message(required): string

    {
        "required":[
            "code",
            "message"
        ],
        "properties":{
            "code":{
                "type":"string"
            },
            "message":{
                "type":"string"
            }
        }
    }

Back to Top